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     public static final String DEVICE_DISCONNECTED = "Device disconnected.";
  87
  88     private final ConnectionContext primaryConnectionContext;
  89     private final DeviceState deviceState;
  90     private final DataBroker dataBroker;
  91     private final HashedWheelTimer hashedWheelTimer;
  92     private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
  93     private final TransactionChainManager txChainManager;
  94     private TranslatorLibrary translatorLibrary;
  95     private final DeviceFlowRegistry deviceFlowRegistry;
  96     private final DeviceGroupRegistry deviceGroupRegistry;
  97     private final DeviceMeterRegistry deviceMeterRegistry;
  98     private Timeout barrierTaskTimeout;
  99     private NotificationService notificationService;
 100     private final MessageSpy messageSpy;
 101     private DeviceDisconnectedHandler deviceDisconnectedHandler;
 102     private final Collection<DeviceContextClosedHandler> closeHandlers = new HashSet<>();
 103     private NotificationPublishService notificationPublishService;
 104     private OutboundQueue outboundQueueProvider;
 105
 106     private volatile int outstandingNotificationsAmount = 0;
 107     private volatile boolean filteringPacketIn = false;
 108     private final Object throttlingLock = new Object();
 109     private int filteringHighWaterMark = 0;
 110     private OutboundQueueHandlerRegistration outboundQueueHandlerRegistration;
 111
 112     @Override
 113     public Long getReservedXid() {
 114         return outboundQueueProvider.reserveEntry();
 115     }
 116
 117     @VisibleForTesting
 118     DeviceContextImpl(@Nonnull final ConnectionContext primaryConnectionContext,
 119                       @Nonnull final DeviceState deviceState,
 120                       @Nonnull final DataBroker dataBroker,
 121                       @Nonnull final HashedWheelTimer hashedWheelTimer,
 122                       @Nonnull final MessageSpy _messageSpy) {
 123         this.primaryConnectionContext = Preconditions.checkNotNull(primaryConnectionContext);
 124         this.deviceState = Preconditions.checkNotNull(deviceState);
 125         this.dataBroker = Preconditions.checkNotNull(dataBroker);
 126         this.hashedWheelTimer = Preconditions.checkNotNull(hashedWheelTimer);
 127         txChainManager = new TransactionChainManager(dataBroker, hashedWheelTimer, 500L, 500L);
 128         auxiliaryConnectionContexts = new HashMap<>();
 129         deviceFlowRegistry = new DeviceFlowRegistryImpl();
 130         deviceGroupRegistry = new DeviceGroupRegistryImpl();
 131         deviceMeterRegistry = new DeviceMeterRegistryImpl();
 132         messageSpy = _messageSpy;
 133         outboundQueueProvider = Preconditions.checkNotNull(primaryConnectionContext.getOutboundQueueProvider());
 134     }
 135
 136     /**
 137      * This method is called from {@link DeviceManagerImpl} only. So we could say "posthandshake process finish"
 138      * and we are able to set a scheduler for an automatic transaction submitting by time (0,5sec).
 139      */
 140     void submitTransaction() {
 141         txChainManager.enableSubmit();
 142         txChainManager.submitTransaction();
 143     }
 144
 145     @Override
 146     public <M extends ChildOf<DataObject>> void onMessage(final M message, final RequestContext<?> requestContext) {
 147         // TODO Auto-generated method stub
 148     }
 149
 150     @Override
 151     public void addAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 152         final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
 153         auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
 154     }
 155
 156     private static SwitchConnectionDistinguisher createConnectionDistinguisher(final ConnectionContext connectionContext) {
 157         return new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
 158     }
 159
 160     @Override
 161     public void removeAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 162         // TODO Auto-generated method stub
 163     }
 164
 165     @Override
 166     public DeviceState getDeviceState() {
 167         return deviceState;
 168     }
 169
 170     @Override
 171     public ReadTransaction getReadTransaction() {
 172         return dataBroker.newReadOnlyTransaction();
 173     }
 174
 175     @Override
 176     public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
 177                                                           final InstanceIdentifier<T> path, final T data) {
 178         txChainManager.writeToTransaction(store, path, data);
 179     }
 180
 181     @Override
 182     public <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path) {
 183         txChainManager.addDeleteOperationTotTxChain(store, path);
 184     }
 185
 186     @Override
 187     public ConnectionContext getPrimaryConnectionContext() {
 188         return primaryConnectionContext;
 189     }
 190
 191     @Override
 192     public ConnectionContext getAuxiliaryConnectiobContexts(final BigInteger cookie) {
 193         return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
 194     }
 195
 196     @Override
 197     public DeviceFlowRegistry getDeviceFlowRegistry() {
 198         return deviceFlowRegistry;
 199     }
 200
 201     @Override
 202     public DeviceGroupRegistry getDeviceGroupRegistry() {
 203         return deviceGroupRegistry;
 204     }
 205
 206     @Override
 207     public DeviceMeterRegistry getDeviceMeterRegistry() {
 208         return deviceMeterRegistry;
 209     }
 210
 211     @Override
 212     public void processReply(final OfHeader ofHeader) {
 213         if (ofHeader instanceof Error) {
 214             messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
 215         } else {
 216             messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 217         }
 218     }
 219
 220     @Override
 221     public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
 222         for (final MultipartReply multipartReply : ofHeaderList) {
 223             messageSpy.spyMessage(multipartReply.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
 224         }
 225     }
 226
 227     @Override
 228     public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
 229         //TODO: will be defined later
 230     }
 231
 232     @Override
 233     public void processPortStatusMessage(final PortStatusMessage portStatus) {
 234         messageSpy.spyMessage(portStatus.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 235         final TranslatorKey translatorKey = new TranslatorKey(portStatus.getVersion(), PortGrouping.class.getName());
 236         final MessageTranslator<PortGrouping, FlowCapableNodeConnector> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
 237         final FlowCapableNodeConnector flowCapableNodeConnector = messageTranslator.translate(portStatus, this, null);
 238
 239         final KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> iiToNodeConnector = provideIIToNodeConnector(portStatus.getPortNo(), portStatus.getVersion());
 240         if (portStatus.getReason().equals(PortReason.OFPPRADD) || portStatus.getReason().equals(PortReason.OFPPRMODIFY)) {
 241             // because of ADD status node connector has to be created
 242             final NodeConnectorBuilder nConnectorBuilder = new NodeConnectorBuilder().setKey(iiToNodeConnector.getKey());
 243             nConnectorBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
 244             nConnectorBuilder.addAugmentation(FlowCapableNodeConnector.class, flowCapableNodeConnector);
 245             writeToTransaction(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector, nConnectorBuilder.build());
 246         } else if (portStatus.getReason().equals(PortReason.OFPPRDELETE)) {
 247             addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector);
 248         }
 249     }
 250
 251     private KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> provideIIToNodeConnector(final long portNo, final short version) {
 252         final InstanceIdentifier<Node> iiToNodes = deviceState.getNodeInstanceIdentifier();
 253         final BigInteger dataPathId = deviceState.getFeatures().getDatapathId();
 254         final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), portNo, version);
 255         return iiToNodes.child(NodeConnector.class, new NodeConnectorKey(nodeConnectorId));
 256     }
 257
 258     @Override
 259     public void processPacketInMessage(final PacketInMessage packetInMessage) {
 260         messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH);
 261         final ConnectionAdapter connectionAdapter = getPrimaryConnectionContext().getConnectionAdapter();
 262
 263         final TranslatorKey translatorKey = new TranslatorKey(packetInMessage.getVersion(), PacketIn.class.getName());
 264         final MessageTranslator<PacketInMessage, PacketReceived> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
 265         final PacketReceived packetReceived = messageTranslator.translate(packetInMessage, this, null);
 266
 267         if (packetReceived == null) {
 268             LOG.debug("Received a null packet from switch");
 269             return;
 270         }
 271         messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_SRC_FAILURE);
 272
 273         final ListenableFuture<? extends Object> offerNotification = notificationPublishService.offerNotification(packetReceived);
 274         synchronized (throttlingLock) {
 275             outstandingNotificationsAmount += 1;
 276         }
 277         if (NotificationPublishService.REJECTED.equals(offerNotification)) {
 278             LOG.debug("notification offer rejected");
 279             synchronized (throttlingLock) {
 280                 if (outstandingNotificationsAmount > 1 && !filteringPacketIn) {
 281                     connectionAdapter.setPacketInFiltering(true);
 282                     messageSpy.spyMessage(DeviceContext.class, MessageSpy.STATISTIC_GROUP.OFJ_BACKPRESSURE_ON);
 283                     filteringPacketIn = true;
 284                     filteringHighWaterMark = outstandingNotificationsAmount;
 285                     LOG.debug("PacketIn filtering on: {}, watermark: {}", connectionAdapter.getRemoteAddress(), outstandingNotificationsAmount);
 286                 }
 287             }
 288         }
 289
 290         Futures.addCallback(offerNotification,
 291                 new FutureCallback<Object>() {
 292                     @Override
 293                     public void onSuccess(final Object result) {
 294                         countdownFiltering();
 295                         messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 296                     }
 297
 298                     @Override
 299                     public void onFailure(final Throwable t) {
 300                         countdownFiltering();
 301                         messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
 302                         LOG.debug("notification offer failed: {}, outstanding: {}", t.getMessage(), outstandingNotificationsAmount);
 303                         LOG.trace("notification offer failed..", t);
 304                     }
 305
 306                     private void countdownFiltering() {
 307                         synchronized (throttlingLock) {
 308                             outstandingNotificationsAmount -= 1;
 309                             if (outstandingNotificationsAmount == 0 && filteringPacketIn) {
 310                                 connectionAdapter.setPacketInFiltering(false);
 311                                 messageSpy.spyMessage(DeviceContext.class, MessageSpy.STATISTIC_GROUP.OFJ_BACKPRESSURE_OFF);
 312
 313                                 filteringPacketIn = false;
 314                                 LOG.debug("PacketIn filtering off: {}, outstanding: {}", connectionAdapter.getRemoteAddress(), outstandingNotificationsAmount);
 315                             }
 316                         }
 317                     }
 318                 }
 319         );
 320     }
 321
 322     @Override
 323     public TranslatorLibrary oook() {
 324         return translatorLibrary;
 325     }
 326
 327     @Override
 328     public void setTranslatorLibrary(final TranslatorLibrary translatorLibrary) {
 329         this.translatorLibrary = translatorLibrary;
 330     }
 331
 332     @Override
 333     public HashedWheelTimer getTimer() {
 334         return hashedWheelTimer;
 335     }
 336
 337     @Override
 338     public void close() {
 339         deviceState.setValid(false);
 340
 341         outboundQueueHandlerRegistration.close();
 342
 343         LOG.trace("Removing node {} from operational DS.", getDeviceState().getNodeId());
 344         addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, getDeviceState().getNodeInstanceIdentifier());
 345
 346         deviceGroupRegistry.close();
 347         deviceFlowRegistry.close();
 348         deviceMeterRegistry.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         for (final DeviceContextClosedHandler deviceContextClosedHandler : closeHandlers) {
 360             deviceContextClosedHandler.onDeviceContextClosed(this);
 361         }
 362     }
 363
 364     @Override
 365     public void onDeviceDisconnected(final ConnectionContext connectionContext) {
 366         if (getPrimaryConnectionContext().equals(connectionContext)) {
 367             try {
 368                 close();
 369             } catch (final Exception e) {
 370                 LOG.trace("Error closing device context.");
 371             }
 372             if (null != deviceDisconnectedHandler) {
 373                 deviceDisconnectedHandler.onDeviceDisconnected(connectionContext);
 374             }
 375         } else {
 376             final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
 377             auxiliaryConnectionContexts.remove(connectionDistinguisher);
 378         }
 379     }
 380
 381     @Override
 382     public void setCurrentBarrierTimeout(final Timeout timeout) {
 383         barrierTaskTimeout = timeout;
 384     }
 385
 386     @Override
 387     public Timeout getBarrierTaskTimeout() {
 388         return barrierTaskTimeout;
 389     }
 390
 391     @Override
 392     public void setNotificationService(final NotificationService notificationServiceParam) {
 393         notificationService = notificationServiceParam;
 394     }
 395
 396     @Override
 397     public void setNotificationPublishService(final NotificationPublishService notificationPublishService) {
 398         this.notificationPublishService = notificationPublishService;
 399     }
 400
 401     @Override
 402     public MessageSpy getMessageSpy() {
 403         return messageSpy;
 404     }
 405
 406     @Override
 407     public void setDeviceDisconnectedHandler(final DeviceDisconnectedHandler deviceDisconnectedHandler) {
 408         this.deviceDisconnectedHandler = deviceDisconnectedHandler;
 409     }
 410
 411     @Override
 412     public void addDeviceContextClosedHandler(final DeviceContextClosedHandler deviceContextClosedHandler) {
 413         closeHandlers.add(deviceContextClosedHandler);
 414     }
 415
 416     @Override
 417     public void startGatheringOperationsToOneTransaction() {
 418         txChainManager.startGatheringOperationsToOneTransaction();
 419     }
 420
 421     @Override
 422     public void commitOperationsGatheredInOneTransaction() {
 423         txChainManager.commitOperationsGatheredInOneTransaction();
 424     }
 425
 426     @Override
 427     public void onPublished() {
 428         primaryConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
 429         for (final ConnectionContext switchAuxConnectionContext : auxiliaryConnectionContexts.values()) {
 430             switchAuxConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
 431         }
 432     }
 433
 434     @Override
 435     public void registerOutboundQueueProvider(final OutboundQueueProvider outboundQueueProvider, final int maxQueueDepth, final long barrierNanos) {
 436         final ConnectionAdapter primaryConnectionAdapter = primaryConnectionContext.getConnectionAdapter();
 437         outboundQueueHandlerRegistration = primaryConnectionAdapter.registerOutboundQueueHandler(outboundQueueProvider, maxQueueDepth, barrierNanos);
 438         this.outboundQueueProvider = outboundQueueProvider;
 439         primaryConnectionContext.setOutboundQueueProvider(outboundQueueProvider);
 440     }
 441
 442     @Override
 443     public MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext) {
 444         return new MultiMsgCollectorImpl(this, requestContext);
 445     }
 446 }