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