openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/ConnectionConductorImpl.java

   1 /**
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.openflowplugin.openflow.md.core;
  10
  11 import java.util.concurrent.Future;
  12 import java.util.concurrent.LinkedBlockingQueue;
  13 import java.util.concurrent.ThreadPoolExecutor;
  14 import java.util.concurrent.TimeUnit;
  15
  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.protocol.rev130731.EchoInputBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoOutput;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoReplyInputBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoRequestMessage;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemovedMessage;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloMessage;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessage;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInputBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OpenflowProtocolListener;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatus;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestDescCaseBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestGroupFeaturesCaseBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestMeterFeaturesCaseBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestPortDescCaseBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.DisconnectEvent;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SwitchIdleEvent;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SystemNotificationsListener;
  53 import org.opendaylight.yangtools.yang.binding.DataObject;
  54 import org.opendaylight.yangtools.yang.common.RpcError;
  55 import org.opendaylight.yangtools.yang.common.RpcResult;
  56 import org.slf4j.Logger;
  57 import org.slf4j.LoggerFactory;
  58
  59 import com.google.common.util.concurrent.Futures;
  60
  61 /**
  62  * @author mirehak
  63  */
  64 public class ConnectionConductorImpl implements OpenflowProtocolListener,
  65         SystemNotificationsListener, ConnectionConductor, ConnectionReadyListener, HandshakeListener {
  66
  67     /** ingress queue limit */
  68     private static final int INGRESS_QUEUE_MAX_SIZE = 200;
  69
  70     protected static final Logger LOG = LoggerFactory
  71             .getLogger(ConnectionConductorImpl.class);
  72
  73     /* variable to make BitMap-based negotiation enabled / disabled.
  74      * it will help while testing and isolating issues related to processing of
  75      * BitMaps from switches.
  76      */
  77     private boolean isBitmapNegotiationEnable = true;
  78     protected ErrorHandler errorHandler;
  79
  80     private final ConnectionAdapter connectionAdapter;
  81     private ConnectionConductor.CONDUCTOR_STATE conductorState;
  82     private Short version;
  83
  84     protected SwitchConnectionDistinguisher auxiliaryKey;
  85
  86     protected SessionContext sessionContext;
  87
  88     private QueueProcessor<OfHeader, DataObject> queueProcessor;
  89     private QueueKeeper<OfHeader> queue;
  90     private ThreadPoolExecutor hsPool;
  91     private HandshakeManager handshakeManager;
  92
  93     private boolean firstHelloProcessed;
  94
  95     private PortFeaturesUtil portFeaturesUtils;
  96
  97     private int conductorId;
  98
  99     private int ingressMaxQueueSize;
 100
 101
 102     /**
 103      * @param connectionAdapter
 104      */
 105     public ConnectionConductorImpl(ConnectionAdapter connectionAdapter) {
 106         this(connectionAdapter, INGRESS_QUEUE_MAX_SIZE);
 107     }
 108
 109     /**
 110      * @param connectionAdapter
 111      * @param ingressMaxQueueSize ingress queue limit (blocking)
 112      */
 113     public ConnectionConductorImpl(ConnectionAdapter connectionAdapter, int ingressMaxQueueSize) {
 114         this.connectionAdapter = connectionAdapter;
 115         this.ingressMaxQueueSize = ingressMaxQueueSize;
 116         conductorState = CONDUCTOR_STATE.HANDSHAKING;
 117         firstHelloProcessed = false;
 118         handshakeManager = new HandshakeManagerImpl(connectionAdapter,
 119                 ConnectionConductor.versionOrder.get(0), ConnectionConductor.versionOrder);
 120         handshakeManager.setUseVersionBitmap(isBitmapNegotiationEnable);
 121         handshakeManager.setHandshakeListener(this);
 122         portFeaturesUtils = PortFeaturesUtil.getInstance();
 123     }
 124
 125     @Override
 126     public void init() {
 127         int handshakeThreadLimit = 1;
 128         hsPool = new ThreadPoolLoggingExecutor(handshakeThreadLimit , handshakeThreadLimit, 0L,
 129                 TimeUnit.MILLISECONDS, new LinkedBlockingQueue<Runnable>(),
 130                 "OFHandshake-"+conductorId);
 131
 132         connectionAdapter.setMessageListener(this);
 133         connectionAdapter.setSystemListener(this);
 134         connectionAdapter.setConnectionReadyListener(this);
 135         queue = QueueKeeperFactory.createFairQueueKeeper(queueProcessor, ingressMaxQueueSize);
 136     }
 137
 138     @Override
 139     public void setQueueProcessor(QueueProcessor<OfHeader, DataObject> queueProcessor) {
 140         this.queueProcessor = queueProcessor;
 141     }
 142
 143     /**
 144      * @param errorHandler the errorHandler to set
 145      */
 146     @Override
 147     public void setErrorHandler(ErrorHandler errorHandler) {
 148         this.errorHandler = errorHandler;
 149         handshakeManager.setErrorHandler(errorHandler);
 150     }
 151
 152     @Override
 153     public void onEchoRequestMessage(final EchoRequestMessage echoRequestMessage) {
 154         new Thread(new Runnable() {
 155             @Override
 156             public void run() {
 157                 LOG.debug("echo request received: " + echoRequestMessage.getXid());
 158                 EchoReplyInputBuilder builder = new EchoReplyInputBuilder();
 159                 builder.setVersion(echoRequestMessage.getVersion());
 160                 builder.setXid(echoRequestMessage.getXid());
 161                 builder.setData(echoRequestMessage.getData());
 162
 163                 getConnectionAdapter().echoReply(builder.build());
 164             }
 165         }).start();
 166     }
 167
 168     @Override
 169     public void onErrorMessage(ErrorMessage errorMessage) {
 170         enqueueMessage(errorMessage);
 171     }
 172
 173
 174     /**
 175      * @param message
 176      */
 177     private void enqueueMessage(OfHeader message) {
 178         enqueueMessage(message, QueueType.DEFAULT);
 179     }
 180
 181     /**
 182      * @param message
 183      * @param queueType enqueue type
 184      */
 185     private void enqueueMessage(OfHeader message, QueueType queueType) {
 186         queue.push(message, this, queueType);
 187     }
 188
 189     @Override
 190     public void onExperimenterMessage(ExperimenterMessage experimenterMessage) {
 191         enqueueMessage(experimenterMessage);
 192     }
 193
 194     @Override
 195     public void onFlowRemovedMessage(FlowRemovedMessage message) {
 196         enqueueMessage(message);
 197     }
 198
 199
 200     /**
 201      * version negotiation happened as per following steps:
 202      * 1. If HelloMessage version field has same version, continue connection processing.
 203      *    If HelloMessage version is lower than supported versions, just disconnect.
 204      * 2. If HelloMessage contains bitmap and common version found in bitmap
 205      *    then continue connection processing. if no common version found, just disconnect.
 206      * 3. If HelloMessage version is not supported, send HelloMessage with lower supported version.
 207      * 4. If Hello message received again with not supported version, just disconnect.
 208      */
 209     @Override
 210     public void onHelloMessage(final HelloMessage hello) {
 211         LOG.debug("processing HELLO.xid: {}", hello.getXid());
 212         firstHelloProcessed = true;
 213         checkState(CONDUCTOR_STATE.HANDSHAKING);
 214         HandshakeStepWrapper handshakeStepWrapper = new HandshakeStepWrapper(
 215                 hello, handshakeManager, connectionAdapter);
 216         hsPool.submit(handshakeStepWrapper);
 217     }
 218
 219     /**
 220      * @return rpc-response timeout in [ms]
 221      */
 222     protected long getMaxTimeout() {
 223         // TODO:: get from configuration
 224         return 2000;
 225     }
 226
 227     /**
 228      * @return milliseconds
 229      */
 230     protected TimeUnit getMaxTimeoutUnit() {
 231         // TODO:: get from configuration
 232         return TimeUnit.MILLISECONDS;
 233     }
 234
 235     @Override
 236     public void onMultipartReplyMessage(MultipartReplyMessage message) {
 237         enqueueMessage(message);
 238     }
 239
 240     @Override
 241     public void onPacketInMessage(PacketInMessage message) {
 242         enqueueMessage(message, QueueKeeper.QueueType.UNORDERED);
 243     }
 244
 245     @Override
 246     public void onPortStatusMessage(PortStatusMessage message) {
 247         processPortStatusMsg(message);
 248         enqueueMessage(message);
 249     }
 250
 251     protected void processPortStatusMsg(PortStatus msg) {
 252         if (msg.getReason().getIntValue() == 2) {
 253             updatePort(msg);
 254         } else if (msg.getReason().getIntValue() == 0) {
 255             updatePort(msg);
 256         } else if (msg.getReason().getIntValue() == 1) {
 257             deletePort(msg);
 258         }
 259     }
 260
 261     protected void updatePort(PortStatus msg) {
 262         Long portNumber = msg.getPortNo();
 263         Boolean portBandwidth = portFeaturesUtils.getPortBandwidth(msg);
 264
 265         if(portBandwidth == null) {
 266             LOG.debug("can't get bandwidth info from port: {}, aborting port update", msg.toString());
 267         } else {
 268             this.getSessionContext().getPhysicalPorts().put(portNumber, msg);
 269             this.getSessionContext().getPortsBandwidth().put(portNumber, portBandwidth);
 270         }
 271     }
 272
 273     protected void deletePort(PortGrouping port) {
 274         Long portNumber = port.getPortNo();
 275
 276         this.getSessionContext().getPhysicalPorts().remove(portNumber);
 277         this.getSessionContext().getPortsBandwidth().remove(portNumber);
 278     }
 279
 280     @Override
 281     public void onSwitchIdleEvent(SwitchIdleEvent notification) {
 282         new Thread(new Runnable() {
 283             @Override
 284             public void run() {
 285                 if (!CONDUCTOR_STATE.WORKING.equals(getConductorState())) {
 286                     // idle state in any other conductorState than WORKING means real
 287                     // problem and wont be handled by echoReply, but disconnection
 288                     disconnect();
 289                     OFSessionUtil.getSessionManager().invalidateOnDisconnect(ConnectionConductorImpl.this);
 290                 } else {
 291                     LOG.debug("first idle state occured, sessionCtx={}|auxId={}", sessionContext, auxiliaryKey);
 292                     EchoInputBuilder builder = new EchoInputBuilder();
 293                     builder.setVersion(getVersion());
 294                     builder.setXid(getSessionContext().getNextXid());
 295
 296                     Future<RpcResult<EchoOutput>> echoReplyFuture = getConnectionAdapter()
 297                             .echo(builder.build());
 298
 299                     try {
 300                         RpcResult<EchoOutput> echoReplyValue = echoReplyFuture.get(getMaxTimeout(),
 301                                 getMaxTimeoutUnit());
 302                         if (echoReplyValue.isSuccessful()) {
 303                             setConductorState(CONDUCTOR_STATE.WORKING);
 304                         } else {
 305                             for (RpcError replyError : echoReplyValue.getErrors()) {
 306                                 Throwable cause = replyError.getCause();
 307                                 LOG.error(
 308                                         "while receiving echoReply in TIMEOUTING state: "
 309                                                 + cause.getMessage(), cause);
 310                             }
 311                             //switch issue occurred
 312                             throw new Exception("switch issue occurred");
 313                         }
 314                     } catch (Exception e) {
 315                         LOG.error("while waiting for echoReply in TIMEOUTING state: "
 316                                 + e.getMessage());
 317                         errorHandler.handleException(e, sessionContext);
 318                         //switch is not responding
 319                         disconnect();
 320                         OFSessionUtil.getSessionManager().invalidateOnDisconnect(ConnectionConductorImpl.this);
 321                     }
 322                 }
 323             }
 324
 325         }).start();
 326     }
 327
 328     /**
 329      * @param conductorState
 330      *            the connectionState to set
 331      */
 332     @Override
 333     public void setConductorState(CONDUCTOR_STATE conductorState) {
 334         this.conductorState = conductorState;
 335     }
 336
 337     @Override
 338     public CONDUCTOR_STATE getConductorState() {
 339         return conductorState;
 340     }
 341
 342     /**
 343      * @param handshaking
 344      */
 345     protected void checkState(CONDUCTOR_STATE expectedState) {
 346         if (!conductorState.equals(expectedState)) {
 347             throw new IllegalStateException("Expected state: " + expectedState
 348                     + ", actual state:" + conductorState);
 349         }
 350     }
 351
 352     @Override
 353     public void onDisconnectEvent(DisconnectEvent arg0) {
 354         SessionManager sessionManager = OFSessionUtil.getSessionManager();
 355         sessionManager.invalidateOnDisconnect(this);
 356     }
 357
 358     @Override
 359     public Short getVersion() {
 360         return version;
 361     }
 362
 363     @Override
 364     public Future<Boolean> disconnect() {
 365         LOG.trace("disconnecting: sessionCtx={}|auxId={}", sessionContext, auxiliaryKey);
 366
 367         Future<Boolean> result = null;
 368         if (connectionAdapter.isAlive()) {
 369             result = connectionAdapter.disconnect();
 370         } else {
 371             LOG.debug("connection already disconnected");
 372             result = Futures.immediateFuture(true);
 373         }
 374
 375         return result;
 376     }
 377
 378     @Override
 379     public void setConnectionCookie(SwitchConnectionDistinguisher auxiliaryKey) {
 380         this.auxiliaryKey = auxiliaryKey;
 381     }
 382
 383     @Override
 384     public void setSessionContext(SessionContext sessionContext) {
 385         this.sessionContext = sessionContext;
 386     }
 387
 388     @Override
 389     public SwitchConnectionDistinguisher getAuxiliaryKey() {
 390         return auxiliaryKey;
 391     }
 392
 393     @Override
 394     public SessionContext getSessionContext() {
 395         return sessionContext;
 396     }
 397
 398     @Override
 399     public ConnectionAdapter getConnectionAdapter() {
 400         return connectionAdapter;
 401     }
 402
 403     @Override
 404     public void onConnectionReady() {
 405         LOG.debug("connection is ready-to-use");
 406         if (! firstHelloProcessed) {
 407             HandshakeStepWrapper handshakeStepWrapper = new HandshakeStepWrapper(
 408                     null, handshakeManager, connectionAdapter);
 409             hsPool.execute(handshakeStepWrapper);
 410             firstHelloProcessed = true;
 411         } else {
 412             LOG.debug("already touched by hello message");
 413         }
 414     }
 415
 416     @Override
 417     public void onHandshakeSuccessfull(GetFeaturesOutput featureOutput,
 418             Short negotiatedVersion) {
 419         postHandshakeBasic(featureOutput, negotiatedVersion);
 420
 421         // post-handshake actions
 422         if(version == OFConstants.OFP_VERSION_1_3){
 423             requestGroupFeatures();
 424             requestMeterFeatures();
 425         } else if (version == OFConstants.OFP_VERSION_1_0) {
 426             //  Because the GetFeaturesOutput contains information about the port
 427             //  in OF1.0 (that we would otherwise get from the PortDesc) we have to pass
 428             //  it up for parsing to convert into a NodeConnectorUpdate
 429             enqueueMessage(featureOutput);
 430         }
 431
 432         requestDesc();
 433         requestPorts();
 434     }
 435
 436     /**
 437      * used by tests
 438      * @param featureOutput
 439      * @param negotiatedVersion
 440      */
 441     protected void postHandshakeBasic(GetFeaturesOutput featureOutput,
 442             Short negotiatedVersion) {
 443         version = negotiatedVersion;
 444         conductorState = CONDUCTOR_STATE.WORKING;
 445         OFSessionUtil.registerSession(this, featureOutput, negotiatedVersion);
 446         hsPool.shutdown();
 447         hsPool.purge();
 448     }
 449
 450     /*
 451      *  Send an OFPMP_DESC request message to the switch
 452      */
 453
 454     private void requestDesc() {
 455         MultipartRequestInputBuilder builder = new MultipartRequestInputBuilder();
 456         builder.setType(MultipartType.OFPMPDESC);
 457         builder.setVersion(getVersion());
 458         builder.setFlags(new MultipartRequestFlags(false));
 459         builder.setMultipartRequestBody(new MultipartRequestDescCaseBuilder().build());
 460         builder.setXid(getSessionContext().getNextXid());
 461         getConnectionAdapter().multipartRequest(builder.build());
 462     }
 463
 464     private void requestPorts() {
 465         MultipartRequestInputBuilder builder = new MultipartRequestInputBuilder();
 466         builder.setType(MultipartType.OFPMPPORTDESC);
 467         builder.setVersion(getVersion());
 468         builder.setFlags(new MultipartRequestFlags(false));
 469         builder.setMultipartRequestBody(new MultipartRequestPortDescCaseBuilder().build());
 470         builder.setXid(getSessionContext().getNextXid());
 471         getConnectionAdapter().multipartRequest(builder.build());
 472     }
 473     private void requestGroupFeatures(){
 474         MultipartRequestInputBuilder mprInput = new MultipartRequestInputBuilder();
 475         mprInput.setType(MultipartType.OFPMPGROUPFEATURES);
 476         mprInput.setVersion(getVersion());
 477         mprInput.setFlags(new MultipartRequestFlags(false));
 478         mprInput.setXid(getSessionContext().getNextXid());
 479
 480         MultipartRequestGroupFeaturesCaseBuilder mprGroupFeaturesBuild =
 481                 new MultipartRequestGroupFeaturesCaseBuilder();
 482         mprInput.setMultipartRequestBody(mprGroupFeaturesBuild.build());
 483
 484         LOG.debug("Send group features statistics request :{}",mprGroupFeaturesBuild);
 485         getConnectionAdapter().multipartRequest(mprInput.build());
 486
 487     }
 488     private void requestMeterFeatures(){
 489         MultipartRequestInputBuilder mprInput = new MultipartRequestInputBuilder();
 490         mprInput.setType(MultipartType.OFPMPMETERFEATURES);
 491         mprInput.setVersion(getVersion());
 492         mprInput.setFlags(new MultipartRequestFlags(false));
 493         mprInput.setXid(getSessionContext().getNextXid());
 494
 495         MultipartRequestMeterFeaturesCaseBuilder mprMeterFeaturesBuild =
 496                 new MultipartRequestMeterFeaturesCaseBuilder();
 497         mprInput.setMultipartRequestBody(mprMeterFeaturesBuild.build());
 498
 499         LOG.debug("Send meter features statistics request :{}",mprMeterFeaturesBuild);
 500         getConnectionAdapter().multipartRequest(mprInput.build());
 501
 502     }
 503     /**
 504      * @param isBitmapNegotiationEnable the isBitmapNegotiationEnable to set
 505      */
 506     public void setBitmapNegotiationEnable(
 507             boolean isBitmapNegotiationEnable) {
 508         this.isBitmapNegotiationEnable = isBitmapNegotiationEnable;
 509     }
 510
 511     protected void shutdownPool() {
 512         hsPool.shutdownNow();
 513         LOG.debug("pool is terminated: {}", hsPool.isTerminated());
 514     }
 515
 516     @Override
 517     public void setId(int conductorId) {
 518         this.conductorId = conductorId;
 519     }
 520 }