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