openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/DeviceContextImpl.java

   1 /**
   2  * Copyright (c) 2015 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 package org.opendaylight.openflowplugin.impl.device;
   9
  10 import com.google.common.annotations.VisibleForTesting;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.util.concurrent.FutureCallback;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import io.netty.util.HashedWheelTimer;
  16 import io.netty.util.Timeout;
  17 import java.math.BigInteger;
  18 import java.util.Collection;
  19 import java.util.HashMap;
  20 import java.util.HashSet;
  21 import java.util.List;
  22 import java.util.Map;
  23 import javax.annotation.Nonnull;
  24 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  25 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  26 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
  27 import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
  28 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  29 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
  30 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
  31 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueueHandlerRegistration;
  32 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  33 import org.opendaylight.openflowplugin.api.openflow.connection.OutboundQueueProvider;
  34 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  35 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  36 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
  37 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  38 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
  39 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  40 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceContextClosedHandler;
  41 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceDisconnectedHandler;
  42 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
  43 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
  44 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
  45 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
  46 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
  47 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
  48 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  49 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
  50 import org.opendaylight.openflowplugin.impl.device.listener.MultiMsgCollectorImpl;
  51 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
  52 import org.opendaylight.openflowplugin.impl.registry.group.DeviceGroupRegistryImpl;
  53 import org.opendaylight.openflowplugin.impl.registry.meter.DeviceMeterRegistryImpl;
  54 import org.opendaylight.openflowplugin.openflow.md.core.session.SwitchConnectionCookieOFImpl;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortReason;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketIn;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
  73 import org.opendaylight.yangtools.yang.binding.ChildOf;
  74 import org.opendaylight.yangtools.yang.binding.DataObject;
  75 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  76 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  77 import org.slf4j.Logger;
  78 import org.slf4j.LoggerFactory;
  79
  80 /**
  81  *
  82  */
  83 public class DeviceContextImpl implements DeviceContext {
  84
  85     private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
  86
  87     private final ConnectionContext primaryConnectionContext;
  88     private final DeviceState deviceState;
  89     private final DataBroker dataBroker;
  90     private final HashedWheelTimer hashedWheelTimer;
  91     private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
  92     private final TransactionChainManager txChainManager;
  93     private TranslatorLibrary translatorLibrary;
  94     private final DeviceFlowRegistry deviceFlowRegistry;
  95     private final DeviceGroupRegistry deviceGroupRegistry;
  96     private final DeviceMeterRegistry deviceMeterRegistry;
  97     private Timeout barrierTaskTimeout;
  98     private NotificationService notificationService;
  99     private final MessageSpy messageSpy;
 100     private DeviceDisconnectedHandler deviceDisconnectedHandler;
 101     private final Collection<DeviceContextClosedHandler> closeHandlers = new HashSet<>();
 102     private NotificationPublishService notificationPublishService;
 103     private OutboundQueue outboundQueueProvider;
 104
 105     private volatile int outstandingNotificationsAmount = 0;
 106     private volatile boolean filteringPacketIn = false;
 107     private final Object throttlingLock = new Object();
 108     private int filteringHighWaterMark = 0;
 109     private OutboundQueueHandlerRegistration<?> outboundQueueHandlerRegistration;
 110
 111     @Override
 112     public Long getReservedXid() {
 113         return outboundQueueProvider.reserveEntry();
 114     }
 115
 116     @VisibleForTesting
 117     DeviceContextImpl(@Nonnull final ConnectionContext primaryConnectionContext,
 118                       @Nonnull final DeviceState deviceState,
 119                       @Nonnull final DataBroker dataBroker,
 120                       @Nonnull final HashedWheelTimer hashedWheelTimer,
 121                       @Nonnull final MessageSpy _messageSpy) {
 122         this.primaryConnectionContext = Preconditions.checkNotNull(primaryConnectionContext);
 123         this.deviceState = Preconditions.checkNotNull(deviceState);
 124         this.dataBroker = Preconditions.checkNotNull(dataBroker);
 125         this.hashedWheelTimer = Preconditions.checkNotNull(hashedWheelTimer);
 126         txChainManager = new TransactionChainManager(dataBroker, deviceState);
 127         auxiliaryConnectionContexts = new HashMap<>();
 128         deviceFlowRegistry = new DeviceFlowRegistryImpl();
 129         deviceGroupRegistry = new DeviceGroupRegistryImpl();
 130         deviceMeterRegistry = new DeviceMeterRegistryImpl();
 131         messageSpy = _messageSpy;
 132     }
 133
 134     /**
 135      * This method is called from {@link DeviceManagerImpl} only. So we could say "posthandshake process finish"
 136      * and we are able to set a scheduler for an automatic transaction submitting by time (0,5sec).
 137      */
 138     void initialSubmitTransaction() {
 139         txChainManager.initialSubmitWriteTransaction();
 140     }
 141
 142     @Override
 143     public <M extends ChildOf<DataObject>> void onMessage(final M message, final RequestContext<?> requestContext) {
 144         // TODO Auto-generated method stub
 145     }
 146
 147     @Override
 148     public void addAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 149         final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
 150         auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
 151     }
 152
 153     private static SwitchConnectionDistinguisher createConnectionDistinguisher(final ConnectionContext connectionContext) {
 154         return new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
 155     }
 156
 157     @Override
 158     public void removeAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 159         // TODO Auto-generated method stub
 160     }
 161
 162     @Override
 163     public DeviceState getDeviceState() {
 164         return deviceState;
 165     }
 166
 167     @Override
 168     public ReadTransaction getReadTransaction() {
 169         return dataBroker.newReadOnlyTransaction();
 170     }
 171
 172     @Override
 173     public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
 174                                                           final InstanceIdentifier<T> path, final T data) {
 175         txChainManager.writeToTransaction(store, path, data);
 176     }
 177
 178     @Override
 179     public <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path) {
 180         txChainManager.addDeleteOperationTotTxChain(store, path);
 181     }
 182
 183     @Override
 184     public boolean submitTransaction() {
 185         return txChainManager.submitWriteTransaction();
 186     }
 187
 188     @Override
 189     public ConnectionContext getPrimaryConnectionContext() {
 190         return primaryConnectionContext;
 191     }
 192
 193     @Override
 194     public ConnectionContext getAuxiliaryConnectiobContexts(final BigInteger cookie) {
 195         return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
 196     }
 197
 198     @Override
 199     public DeviceFlowRegistry getDeviceFlowRegistry() {
 200         return deviceFlowRegistry;
 201     }
 202
 203     @Override
 204     public DeviceGroupRegistry getDeviceGroupRegistry() {
 205         return deviceGroupRegistry;
 206     }
 207
 208     @Override
 209     public DeviceMeterRegistry getDeviceMeterRegistry() {
 210         return deviceMeterRegistry;
 211     }
 212
 213     @Override
 214     public void processReply(final OfHeader ofHeader) {
 215         if (ofHeader instanceof Error) {
 216             messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
 217         } else {
 218             messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 219         }
 220     }
 221
 222     @Override
 223     public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
 224         for (final MultipartReply multipartReply : ofHeaderList) {
 225             messageSpy.spyMessage(multipartReply.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
 226         }
 227     }
 228
 229     @Override
 230     public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
 231         //TODO: will be defined later
 232     }
 233
 234     @Override
 235     public void processPortStatusMessage(final PortStatusMessage portStatus) {
 236         messageSpy.spyMessage(portStatus.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 237         final TranslatorKey translatorKey = new TranslatorKey(portStatus.getVersion(), PortGrouping.class.getName());
 238         final MessageTranslator<PortGrouping, FlowCapableNodeConnector> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
 239         final FlowCapableNodeConnector flowCapableNodeConnector = messageTranslator.translate(portStatus, this, null);
 240
 241         final KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> iiToNodeConnector = provideIIToNodeConnector(portStatus.getPortNo(), portStatus.getVersion());
 242         if (portStatus.getReason().equals(PortReason.OFPPRADD) || portStatus.getReason().equals(PortReason.OFPPRMODIFY)) {
 243             // because of ADD status node connector has to be created
 244             final NodeConnectorBuilder nConnectorBuilder = new NodeConnectorBuilder().setKey(iiToNodeConnector.getKey());
 245             nConnectorBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
 246             nConnectorBuilder.addAugmentation(FlowCapableNodeConnector.class, flowCapableNodeConnector);
 247             writeToTransaction(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector, nConnectorBuilder.build());
 248         } else if (portStatus.getReason().equals(PortReason.OFPPRDELETE)) {
 249             addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector);
 250         }
 251         submitTransaction();
 252     }
 253
 254     private KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> provideIIToNodeConnector(final long portNo, final short version) {
 255         final InstanceIdentifier<Node> iiToNodes = deviceState.getNodeInstanceIdentifier();
 256         final BigInteger dataPathId = deviceState.getFeatures().getDatapathId();
 257         final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), portNo, version);
 258         return iiToNodes.child(NodeConnector.class, new NodeConnectorKey(nodeConnectorId));
 259     }
 260
 261     @Override
 262     public void processPacketInMessage(final PacketInMessage packetInMessage) {
 263         messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH);
 264         final ConnectionAdapter connectionAdapter = getPrimaryConnectionContext().getConnectionAdapter();
 265
 266         final TranslatorKey translatorKey = new TranslatorKey(packetInMessage.getVersion(), PacketIn.class.getName());
 267         final MessageTranslator<PacketInMessage, PacketReceived> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
 268         final PacketReceived packetReceived = messageTranslator.translate(packetInMessage, this, null);
 269
 270         if (packetReceived == null) {
 271             LOG.debug("Received a null packet from switch");
 272             return;
 273         }
 274         messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_SRC_FAILURE);
 275
 276         final ListenableFuture<? extends Object> offerNotification = notificationPublishService.offerNotification(packetReceived);
 277         synchronized (throttlingLock) {
 278             outstandingNotificationsAmount += 1;
 279         }
 280         if (NotificationPublishService.REJECTED.equals(offerNotification)) {
 281             LOG.debug("notification offer rejected");
 282             synchronized (throttlingLock) {
 283                 if (outstandingNotificationsAmount > 1 && !filteringPacketIn) {
 284                     connectionAdapter.setPacketInFiltering(true);
 285                     messageSpy.spyMessage(DeviceContext.class, MessageSpy.STATISTIC_GROUP.OFJ_BACKPRESSURE_ON);
 286                     filteringPacketIn = true;
 287                     filteringHighWaterMark = outstandingNotificationsAmount;
 288                     LOG.debug("PacketIn filtering on: {}, watermark: {}", connectionAdapter.getRemoteAddress(), outstandingNotificationsAmount);
 289                 }
 290             }
 291         }
 292
 293         Futures.addCallback(offerNotification,
 294                 new FutureCallback<Object>() {
 295                     @Override
 296                     public void onSuccess(final Object result) {
 297                         countdownFiltering();
 298                         messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 299                     }
 300
 301                     @Override
 302                     public void onFailure(final Throwable t) {
 303                         countdownFiltering();
 304                         messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
 305                         LOG.debug("notification offer failed: {}, outstanding: {}", t.getMessage(), outstandingNotificationsAmount);
 306                         LOG.trace("notification offer failed..", t);
 307                     }
 308
 309                     private void countdownFiltering() {
 310                         synchronized (throttlingLock) {
 311                             outstandingNotificationsAmount -= 1;
 312                             if (outstandingNotificationsAmount == 0 && filteringPacketIn) {
 313                                 connectionAdapter.setPacketInFiltering(false);
 314                                 messageSpy.spyMessage(DeviceContext.class, MessageSpy.STATISTIC_GROUP.OFJ_BACKPRESSURE_OFF);
 315
 316                                 filteringPacketIn = false;
 317                                 LOG.debug("PacketIn filtering off: {}, outstanding: {}", connectionAdapter.getRemoteAddress(), outstandingNotificationsAmount);
 318                             }
 319                         }
 320                     }
 321                 }
 322         );
 323     }
 324
 325     @Override
 326     public TranslatorLibrary oook() {
 327         return translatorLibrary;
 328     }
 329
 330     @Override
 331     public void setTranslatorLibrary(final TranslatorLibrary translatorLibrary) {
 332         this.translatorLibrary = translatorLibrary;
 333     }
 334
 335     @Override
 336     public HashedWheelTimer getTimer() {
 337         return hashedWheelTimer;
 338     }
 339
 340     @Override
 341     public void close() throws Exception {
 342         deviceState.setValid(false);
 343
 344         deviceGroupRegistry.close();
 345         deviceFlowRegistry.close();
 346         deviceMeterRegistry.close();
 347
 348         outboundQueueHandlerRegistration.close();
 349
 350         if (primaryConnectionContext.getConnectionAdapter().isAlive()) {
 351             primaryConnectionContext.setConnectionState(ConnectionContext.CONNECTION_STATE.RIP);
 352             primaryConnectionContext.getConnectionAdapter().disconnect();
 353         }
 354         for (final ConnectionContext connectionContext : auxiliaryConnectionContexts.values()) {
 355             if (connectionContext.getConnectionAdapter().isAlive()) {
 356                 connectionContext.getConnectionAdapter().disconnect();
 357             }
 358         }
 359
 360         for (final DeviceContextClosedHandler deviceContextClosedHandler : closeHandlers) {
 361             deviceContextClosedHandler.onDeviceContextClosed(this);
 362         }
 363
 364         txChainManager.close();
 365     }
 366
 367     @Override
 368     public void onDeviceDisconnected(final ConnectionContext connectionContext) {
 369         if (getPrimaryConnectionContext().equals(connectionContext)) {
 370             try {
 371                 close();
 372             } catch (final Exception e) {
 373                 LOG.trace("Error closing device context.");
 374             }
 375             if (null != deviceDisconnectedHandler) {
 376                 deviceDisconnectedHandler.onDeviceDisconnected(connectionContext);
 377             }
 378         } else {
 379             final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
 380             auxiliaryConnectionContexts.remove(connectionDistinguisher);
 381         }
 382     }
 383
 384     @Override
 385     public void setCurrentBarrierTimeout(final Timeout timeout) {
 386         barrierTaskTimeout = timeout;
 387     }
 388
 389     @Override
 390     public Timeout getBarrierTaskTimeout() {
 391         return barrierTaskTimeout;
 392     }
 393
 394     @Override
 395     public void setNotificationService(final NotificationService notificationServiceParam) {
 396         notificationService = notificationServiceParam;
 397     }
 398
 399     @Override
 400     public void setNotificationPublishService(final NotificationPublishService notificationPublishService) {
 401         this.notificationPublishService = notificationPublishService;
 402     }
 403
 404     @Override
 405     public MessageSpy getMessageSpy() {
 406         return messageSpy;
 407     }
 408
 409     @Override
 410     public void setDeviceDisconnectedHandler(final DeviceDisconnectedHandler deviceDisconnectedHandler) {
 411         this.deviceDisconnectedHandler = deviceDisconnectedHandler;
 412     }
 413
 414     @Override
 415     public void addDeviceContextClosedHandler(final DeviceContextClosedHandler deviceContextClosedHandler) {
 416         closeHandlers.add(deviceContextClosedHandler);
 417     }
 418
 419     @Override
 420     public void onPublished() {
 421         primaryConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
 422         for (final ConnectionContext switchAuxConnectionContext : auxiliaryConnectionContexts.values()) {
 423             switchAuxConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
 424         }
 425     }
 426
 427     @Override
 428     public void registerOutboundQueueProvider(final OutboundQueueProvider outboundQueueProvider, final int maxQueueDepth, final long barrierNanos) {
 429         final ConnectionAdapter primaryConnectionAdapter = primaryConnectionContext.getConnectionAdapter();
 430         outboundQueueHandlerRegistration = primaryConnectionAdapter.registerOutboundQueueHandler(outboundQueueProvider, maxQueueDepth, barrierNanos);
 431         this.outboundQueueProvider = outboundQueueProvider;
 432         primaryConnectionContext.setOutboundQueueProvider(outboundQueueProvider);
 433     }
 434
 435     @Override
 436     public MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext) {
 437         return new MultiMsgCollectorImpl(this, requestContext);
 438     }
 439 }