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.Function;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.base.Verify;
  14 import com.google.common.util.concurrent.AsyncFunction;
  15 import com.google.common.util.concurrent.FutureCallback;
  16 import com.google.common.util.concurrent.Futures;
  17 import com.google.common.util.concurrent.ListenableFuture;
  18 import io.netty.util.Timeout;
  19 import java.math.BigInteger;
  20 import java.util.HashMap;
  21 import java.util.List;
  22 import java.util.Map;
  23 import java.util.concurrent.ConcurrentHashMap;
  24 import java.util.concurrent.atomic.AtomicLong;
  25 import javax.annotation.CheckForNull;
  26 import javax.annotation.Nonnull;
  27 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  28 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  29 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  30 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  31 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
  32 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
  33 import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
  34 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  35 import org.opendaylight.openflowplugin.api.openflow.connection.OutboundQueueProvider;
  36 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  37 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  38 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  39 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
  40 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  41 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
  42 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  43 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
  44 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleConductor;
  45 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
  46 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
  47 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
  48 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
  49 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowDescriptor;
  50 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowRegistryKey;
  51 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
  52 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
  53 import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleKeeper;
  54 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
  55 import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
  56 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
  57 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  58 import org.opendaylight.openflowplugin.extension.api.ConvertorMessageFromOFJava;
  59 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterProviderKeeper;
  60 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
  61 import org.opendaylight.openflowplugin.extension.api.exception.ConversionException;
  62 import org.opendaylight.openflowplugin.extension.api.path.MessagePath;
  63 import org.opendaylight.openflowplugin.impl.common.ItemLifeCycleSourceImpl;
  64 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
  65 import org.opendaylight.openflowplugin.impl.device.listener.MultiMsgCollectorImpl;
  66 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
  67 import org.opendaylight.openflowplugin.impl.registry.flow.FlowRegistryKeyFactory;
  68 import org.opendaylight.openflowplugin.impl.registry.group.DeviceGroupRegistryImpl;
  69 import org.opendaylight.openflowplugin.impl.registry.meter.DeviceMeterRegistryImpl;
  70 import org.opendaylight.openflowplugin.impl.util.DeviceInitializationUtils;
  71 import org.opendaylight.openflowplugin.impl.util.MdSalRegistrationUtils;
  72 import org.opendaylight.openflowplugin.openflow.md.core.session.SwitchConnectionCookieOFImpl;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.experimenter.message.service.rev151020.ExperimenterMessageFromDevBuilder;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortReason;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketIn;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.experimenter.core.ExperimenterDataOfChoice;
  97 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.experimenter.types.rev151020.experimenter.core.message.ExperimenterMessageOfChoice;
  98 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
  99 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
 100 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
 101 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
 102 import org.opendaylight.yangtools.yang.binding.DataObject;
 103 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 104 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
 105 import org.slf4j.Logger;
 106 import org.slf4j.LoggerFactory;
 107
 108 /**
 109  *
 110  */
 111 public class DeviceContextImpl implements DeviceContext, ExtensionConverterProviderKeeper {
 112
 113     private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
 114
 115     // TODO: drain factor should be parametrized
 116     private static final float REJECTED_DRAIN_FACTOR = 0.25f;
 117     // TODO: low water mark factor should be parametrized
 118     private static final float LOW_WATERMARK_FACTOR = 0.75f;
 119     // TODO: high water mark factor should be parametrized
 120     private static final float HIGH_WATERMARK_FACTOR = 0.95f;
 121
 122     private final ConnectionContext primaryConnectionContext;
 123     private final DeviceState deviceState;
 124     private final DataBroker dataBroker;
 125     private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
 126     private final TransactionChainManager transactionChainManager;
 127     private final DeviceFlowRegistry deviceFlowRegistry;
 128     private final DeviceGroupRegistry deviceGroupRegistry;
 129     private final DeviceMeterRegistry deviceMeterRegistry;
 130     private final PacketInRateLimiter packetInLimiter;
 131     private final MessageSpy messageSpy;
 132     private final ItemLifeCycleKeeper flowLifeCycleKeeper;
 133     private NotificationPublishService notificationPublishService;
 134     private final OutboundQueue outboundQueueProvider;
 135     private Timeout barrierTaskTimeout;
 136     private final MessageTranslator<PortGrouping, FlowCapableNodeConnector> portStatusTranslator;
 137     private final MessageTranslator<PacketInMessage, PacketReceived> packetInTranslator;
 138     private final MessageTranslator<FlowRemoved, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved> flowRemovedTranslator;
 139     private final TranslatorLibrary translatorLibrary;
 140     private final Map<Long, NodeConnectorRef> nodeConnectorCache;
 141     private final ItemLifeCycleRegistry itemLifeCycleSourceRegistry;
 142     private ExtensionConverterProvider extensionConverterProvider;
 143
 144     private final boolean switchFeaturesMandatory;
 145     private StatisticsContext statisticsContext;
 146
 147     private final DeviceInfo deviceInfo;
 148
 149     private volatile DEVICE_CONTEXT_STATE deviceCtxState;
 150
 151     @VisibleForTesting
 152     DeviceContextImpl(@Nonnull final ConnectionContext primaryConnectionContext,
 153                       @Nonnull final DeviceState deviceState,
 154                       @Nonnull final DataBroker dataBroker,
 155                       @Nonnull final LifecycleConductor conductor,
 156                       @Nonnull final OutboundQueueProvider outboundQueueProvider,
 157                       @Nonnull final TranslatorLibrary translatorLibrary,
 158                       final boolean switchFeaturesMandatory) {
 159         this.switchFeaturesMandatory = switchFeaturesMandatory;
 160         this.primaryConnectionContext = Preconditions.checkNotNull(primaryConnectionContext);
 161         this.deviceState = Preconditions.checkNotNull(deviceState);
 162         this.dataBroker = Preconditions.checkNotNull(dataBroker);
 163         Preconditions.checkNotNull(conductor);
 164         this.outboundQueueProvider = Preconditions.checkNotNull(outboundQueueProvider);
 165         deviceInfo = primaryConnectionContext.getDeviceInfo();
 166         this.transactionChainManager = new TransactionChainManager(dataBroker, deviceInfo, conductor);
 167         auxiliaryConnectionContexts = new HashMap<>();
 168         deviceFlowRegistry = new DeviceFlowRegistryImpl();
 169         deviceGroupRegistry = new DeviceGroupRegistryImpl();
 170         deviceMeterRegistry = new DeviceMeterRegistryImpl();
 171         messageSpy = conductor.getMessageIntelligenceAgency();
 172
 173
 174         packetInLimiter = new PacketInRateLimiter(primaryConnectionContext.getConnectionAdapter(),
 175                 /*initial*/ 1000, /*initial*/2000, messageSpy, REJECTED_DRAIN_FACTOR);
 176
 177         this.translatorLibrary = translatorLibrary;
 178         portStatusTranslator = translatorLibrary.lookupTranslator(
 179                 new TranslatorKey(deviceInfo.getVersion(), PortGrouping.class.getName()));
 180         packetInTranslator = translatorLibrary.lookupTranslator(
 181                 new TranslatorKey(deviceInfo.getVersion(), PacketIn.class.getName()));
 182         flowRemovedTranslator = translatorLibrary.lookupTranslator(
 183                 new TranslatorKey(deviceInfo.getVersion(), FlowRemoved.class.getName()));
 184
 185
 186         nodeConnectorCache = new ConcurrentHashMap<>();
 187
 188         itemLifeCycleSourceRegistry = new ItemLifeCycleRegistryImpl();
 189         flowLifeCycleKeeper = new ItemLifeCycleSourceImpl();
 190         itemLifeCycleSourceRegistry.registerLifeCycleSource(flowLifeCycleKeeper);
 191         deviceCtxState = DEVICE_CONTEXT_STATE.INITIALIZATION;
 192     }
 193
 194     /**
 195      * This method is called from {@link DeviceManagerImpl} only. So we could say "posthandshake process finish"
 196      * and we are able to set a scheduler for an automatic transaction submitting by time (0,5sec).
 197      */
 198     void initialSubmitTransaction() {
 199         transactionChainManager.initialSubmitWriteTransaction();
 200     }
 201
 202     @Override
 203     public Long reserveXidForDeviceMessage() {
 204         return outboundQueueProvider.reserveEntry();
 205     }
 206
 207     @Override
 208     public void addAuxiliaryConnectionContext(final ConnectionContext connectionContext) {
 209         final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
 210         auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
 211     }
 212
 213     private static SwitchConnectionDistinguisher createConnectionDistinguisher(final ConnectionContext connectionContext) {
 214         return new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
 215     }
 216
 217     @Override
 218     public void removeAuxiliaryConnectionContext(final ConnectionContext connectionContext) {
 219         final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
 220         LOG.debug("auxiliary connection dropped: {}, nodeId:{}", connectionContext.getConnectionAdapter()
 221                 .getRemoteAddress(), deviceInfo.getNodeId());
 222         auxiliaryConnectionContexts.remove(connectionDistinguisher);
 223     }
 224
 225     @Override
 226     public DeviceState getDeviceState() {
 227         return deviceState;
 228     }
 229
 230     @Override
 231     public DeviceInfo getDeviceInfo() {
 232         return this.deviceInfo;
 233     }
 234
 235     @Override
 236     public ReadOnlyTransaction getReadTransaction() {
 237         return dataBroker.newReadOnlyTransaction();
 238     }
 239
 240     @Override
 241     public ListenableFuture<Void> onDeviceTakeClusterLeadership() {
 242         LOG.trace("onDeviceTakeClusterLeadership for node: {}", deviceInfo.getNodeId());
 243         /* validation */
 244         if (statisticsContext == null) {
 245             final String errMsg = String.format("DeviceCtx %s is up but we are missing StatisticsContext", deviceInfo.getDatapathId());
 246             LOG.warn(errMsg);
 247             return Futures.immediateFailedFuture(new IllegalStateException(errMsg));
 248         }
 249
 250         /* Prepare init info collecting */
 251         getDeviceState().setDeviceSynchronized(false);
 252         transactionChainManager.activateTransactionManager();
 253         /* Init Collecting NodeInfo */
 254         final ListenableFuture<Void> initCollectingDeviceInfo = DeviceInitializationUtils.initializeNodeInformation(
 255                 DeviceContextImpl.this, switchFeaturesMandatory);
 256         /* Init Collecting StatInfo */
 257         final ListenableFuture<Boolean> statPollFuture = Futures.transform(initCollectingDeviceInfo,
 258                 new AsyncFunction<Void, Boolean>() {
 259
 260                     @Override
 261                     public ListenableFuture<Boolean> apply(@Nonnull final Void input) throws Exception {
 262                         getStatisticsContext().statListForCollectingInitialization();
 263                         return getStatisticsContext().gatherDynamicData();
 264                     }
 265                 });
 266
 267         return Futures.transform(statPollFuture, new Function<Boolean, Void>() {
 268
 269             @Override
 270             public Void apply(final Boolean input) {
 271                 if (ConnectionContext.CONNECTION_STATE.RIP.equals(getPrimaryConnectionContext().getConnectionState())) {
 272                     final String errMsg = String.format("We lost connection for Device %s, context has to be closed.",
 273                             getDeviceInfo().getNodeId());
 274                     LOG.warn(errMsg);
 275                     throw new IllegalStateException(errMsg);
 276                 }
 277                 if (!input) {
 278                     final String errMsg = String.format("Get Initial Device %s information fails",
 279                             getDeviceInfo().getNodeId());
 280                     LOG.warn(errMsg);
 281                     throw new IllegalStateException(errMsg);
 282                 }
 283                 LOG.debug("Get Initial Device {} information is successful", deviceInfo.getNodeId());
 284                 getDeviceState().setDeviceSynchronized(true);
 285                 initialSubmitTransaction();
 286                 getDeviceState().setStatisticsPollingEnabledProp(true);
 287                 return null;
 288             }
 289         });
 290     }
 291
 292     @Override
 293     public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
 294                                                           final InstanceIdentifier<T> path, final T data) throws Exception {
 295         transactionChainManager.writeToTransaction(store, path, data, false);
 296     }
 297
 298     @Override
 299     public <T extends DataObject> void writeToTransactionWithParentsSlow(LogicalDatastoreType store, InstanceIdentifier<T> path, T data) throws Exception {
 300         transactionChainManager.writeToTransaction(store, path, data, true);
 301     }
 302
 303     @Override
 304     public <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path) throws Exception {
 305         transactionChainManager.addDeleteOperationTotTxChain(store, path);
 306     }
 307
 308     @Override
 309     public boolean submitTransaction() {
 310         return transactionChainManager.submitWriteTransaction();
 311     }
 312
 313     @Override
 314     public ConnectionContext getPrimaryConnectionContext() {
 315         return primaryConnectionContext;
 316     }
 317
 318     @Override
 319     public ConnectionContext getAuxiliaryConnectiobContexts(final BigInteger cookie) {
 320         return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
 321     }
 322
 323     @Override
 324     public DeviceFlowRegistry getDeviceFlowRegistry() {
 325         return deviceFlowRegistry;
 326     }
 327
 328     @Override
 329     public DeviceGroupRegistry getDeviceGroupRegistry() {
 330         return deviceGroupRegistry;
 331     }
 332
 333     @Override
 334     public DeviceMeterRegistry getDeviceMeterRegistry() {
 335         return deviceMeterRegistry;
 336     }
 337
 338     @Override
 339     public void processReply(final OfHeader ofHeader) {
 340         if (ofHeader instanceof Error) {
 341             messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
 342         } else {
 343             messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 344         }
 345     }
 346
 347     @Override
 348     public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
 349         for (final MultipartReply multipartReply : ofHeaderList) {
 350             messageSpy.spyMessage(multipartReply.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
 351         }
 352     }
 353
 354     @Override
 355     public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
 356         final ItemLifecycleListener itemLifecycleListener = flowLifeCycleKeeper.getItemLifecycleListener();
 357         if (itemLifecycleListener != null) {
 358             //1. translate to general flow (table, priority, match, cookie)
 359             final org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved flowRemovedNotification =
 360                     flowRemovedTranslator.translate(flowRemoved, deviceInfo, null);
 361             //2. create registry key
 362             final FlowRegistryKey flowRegKey = FlowRegistryKeyFactory.create(flowRemovedNotification);
 363             //3. lookup flowId
 364             final FlowDescriptor flowDescriptor = deviceFlowRegistry.retrieveIdForFlow(flowRegKey);
 365             //4. if flowId present:
 366             if (flowDescriptor != null) {
 367                 // a) construct flow path
 368                 final KeyedInstanceIdentifier<Flow, FlowKey> flowPath = getDeviceInfo().getNodeInstanceIdentifier()
 369                         .augmentation(FlowCapableNode.class)
 370                         .child(Table.class, flowDescriptor.getTableKey())
 371                         .child(Flow.class, new FlowKey(flowDescriptor.getFlowId()));
 372                 // b) notify listener
 373                 itemLifecycleListener.onRemoved(flowPath);
 374                 // c) trigger off a notification
 375                 notificationPublishService.offerNotification(flowRemovedNotification);
 376             } else {
 377                 LOG.debug("flow id not found: nodeId={} tableId={}, priority={}",
 378                         getDeviceInfo().getNodeId(), flowRegKey.getTableId(), flowRemovedNotification.getPriority());
 379             }
 380         }
 381     }
 382
 383     @Override
 384     public void processPortStatusMessage(final PortStatusMessage portStatus) {
 385         messageSpy.spyMessage(portStatus.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 386         final FlowCapableNodeConnector flowCapableNodeConnector = portStatusTranslator.translate(portStatus, deviceInfo, null);
 387
 388         final KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> iiToNodeConnector = provideIIToNodeConnector(portStatus.getPortNo(), portStatus.getVersion());
 389         try {
 390             if (portStatus.getReason().equals(PortReason.OFPPRADD) || portStatus.getReason().equals(PortReason.OFPPRMODIFY)) {
 391                 // because of ADD status node connector has to be created
 392                 final NodeConnectorBuilder nConnectorBuilder = new NodeConnectorBuilder().setKey(iiToNodeConnector.getKey());
 393                 nConnectorBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
 394                 nConnectorBuilder.addAugmentation(FlowCapableNodeConnector.class, flowCapableNodeConnector);
 395                 writeToTransaction(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector, nConnectorBuilder.build());
 396             } else if (portStatus.getReason().equals(PortReason.OFPPRDELETE)) {
 397                 addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector);
 398             }
 399             submitTransaction();
 400         } catch (final Exception e) {
 401             LOG.warn("Error processing port status message: {}", e.getMessage());
 402         }
 403     }
 404
 405     private KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> provideIIToNodeConnector(final long portNo, final short version) {
 406         final InstanceIdentifier<Node> iiToNodes = deviceInfo.getNodeInstanceIdentifier();
 407         final BigInteger dataPathId = deviceInfo.getDatapathId();
 408         final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), portNo, version);
 409         return iiToNodes.child(NodeConnector.class, new NodeConnectorKey(nodeConnectorId));
 410     }
 411
 412     @Override
 413     public void processPacketInMessage(final PacketInMessage packetInMessage) {
 414         messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH);
 415         final ConnectionAdapter connectionAdapter = getPrimaryConnectionContext().getConnectionAdapter();
 416         final PacketReceived packetReceived = packetInTranslator.translate(packetInMessage, deviceInfo, null);
 417
 418         if (packetReceived == null) {
 419             LOG.debug("Received a null packet from switch {}", connectionAdapter.getRemoteAddress());
 420             messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_SRC_FAILURE);
 421             return;
 422         } else {
 423             messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_OUT_SUCCESS);
 424         }
 425
 426         if (!packetInLimiter.acquirePermit()) {
 427             LOG.debug("Packet limited");
 428             // TODO: save packet into emergency slot if possible
 429             messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PACKET_IN_LIMIT_REACHED_AND_DROPPED);
 430             return;
 431         }
 432
 433         final ListenableFuture<?> offerNotification = notificationPublishService.offerNotification(packetReceived);
 434         if (NotificationPublishService.REJECTED.equals(offerNotification)) {
 435             LOG.debug("notification offer rejected");
 436             messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
 437             packetInLimiter.drainLowWaterMark();
 438             packetInLimiter.releasePermit();
 439             return;
 440         }
 441
 442         Futures.addCallback(offerNotification, new FutureCallback<Object>() {
 443             @Override
 444             public void onSuccess(final Object result) {
 445                 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 446                 packetInLimiter.releasePermit();
 447             }
 448
 449             @Override
 450             public void onFailure(final Throwable t) {
 451                 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
 452                 LOG.debug("notification offer failed: {}", t.getMessage());
 453                 LOG.trace("notification offer failed..", t);
 454                 packetInLimiter.releasePermit();
 455             }
 456         });
 457     }
 458
 459     @Override
 460     public void processExperimenterMessage(final ExperimenterMessage notification) {
 461         // lookup converter
 462         final ExperimenterDataOfChoice vendorData = notification.getExperimenterDataOfChoice();
 463         final MessageTypeKey<? extends ExperimenterDataOfChoice> key = new MessageTypeKey<>(
 464                 deviceInfo.getVersion(),
 465                 (Class<? extends ExperimenterDataOfChoice>) vendorData.getImplementedInterface());
 466         final ConvertorMessageFromOFJava<ExperimenterDataOfChoice, MessagePath> messageConverter = extensionConverterProvider.getMessageConverter(key);
 467         if (messageConverter == null) {
 468             LOG.warn("custom converter for {}[OF:{}] not found",
 469                     notification.getExperimenterDataOfChoice().getImplementedInterface(),
 470                     deviceInfo.getVersion());
 471             return;
 472         }
 473         // build notification
 474         final ExperimenterMessageOfChoice messageOfChoice;
 475         try {
 476             messageOfChoice = messageConverter.convert(vendorData, MessagePath.MESSAGE_NOTIFICATION);
 477             final ExperimenterMessageFromDevBuilder experimenterMessageFromDevBld = new ExperimenterMessageFromDevBuilder()
 478                 .setNode(new NodeRef(deviceInfo.getNodeInstanceIdentifier()))
 479                     .setExperimenterMessageOfChoice(messageOfChoice);
 480             // publish
 481             notificationPublishService.offerNotification(experimenterMessageFromDevBld.build());
 482         } catch (final ConversionException e) {
 483             LOG.error("Conversion of experimenter notification failed", e);
 484         }
 485     }
 486
 487     @Override
 488     public TranslatorLibrary oook() {
 489         return translatorLibrary;
 490     }
 491
 492     @Override
 493     public synchronized void close() {
 494         LOG.debug("closing deviceContext: {}, nodeId:{}",
 495                 getPrimaryConnectionContext().getConnectionAdapter().getRemoteAddress(),
 496                 getDeviceInfo().getNodeId());
 497         // NOOP
 498         throw new UnsupportedOperationException("Autocloseble.close will be removed soon");
 499     }
 500
 501     @Override
 502     public void setCurrentBarrierTimeout(final Timeout timeout) {
 503         barrierTaskTimeout = timeout;
 504     }
 505
 506     @Override
 507     public Timeout getBarrierTaskTimeout() {
 508         return barrierTaskTimeout;
 509     }
 510
 511     @Override
 512     public void setNotificationPublishService(final NotificationPublishService notificationPublishService) {
 513         this.notificationPublishService = notificationPublishService;
 514     }
 515
 516     @Override
 517     public MessageSpy getMessageSpy() {
 518         return messageSpy;
 519     }
 520
 521     @Override
 522     public void onPublished() {
 523         Verify.verify(DEVICE_CONTEXT_STATE.INITIALIZATION.equals(deviceCtxState));
 524         deviceCtxState = DEVICE_CONTEXT_STATE.WORKING;
 525         primaryConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
 526         for (final ConnectionContext switchAuxConnectionContext : auxiliaryConnectionContexts.values()) {
 527             switchAuxConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
 528         }
 529     }
 530
 531     @Override
 532     public MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext) {
 533         return new MultiMsgCollectorImpl(this, requestContext);
 534     }
 535
 536     @Override
 537     public NodeConnectorRef lookupNodeConnectorRef(final Long portNumber) {
 538         return nodeConnectorCache.get(portNumber);
 539     }
 540
 541     @Override
 542     public void storeNodeConnectorRef(@Nonnull final Long portNumber, @Nonnull final NodeConnectorRef nodeConnectorRef) {
 543         nodeConnectorCache.put(
 544                 Preconditions.checkNotNull(portNumber),
 545                 Preconditions.checkNotNull(nodeConnectorRef));
 546     }
 547
 548     @Override
 549     public void updatePacketInRateLimit(final long upperBound) {
 550         packetInLimiter.changeWaterMarks((int) (LOW_WATERMARK_FACTOR * upperBound), (int) (HIGH_WATERMARK_FACTOR * upperBound));
 551     }
 552
 553     @Override
 554     public ItemLifeCycleRegistry getItemLifeCycleSourceRegistry() {
 555         return itemLifeCycleSourceRegistry;
 556     }
 557
 558     @Override
 559     public void setExtensionConverterProvider(final ExtensionConverterProvider extensionConverterProvider) {
 560         this.extensionConverterProvider = extensionConverterProvider;
 561     }
 562
 563     @Override
 564     public ExtensionConverterProvider getExtensionConverterProvider() {
 565         return extensionConverterProvider;
 566     }
 567
 568     @Override
 569     public void setStatisticsContext(final StatisticsContext statisticsContext) {
 570         this.statisticsContext = statisticsContext;
 571     }
 572
 573     @Override
 574     public StatisticsContext getStatisticsContext() {
 575         return statisticsContext;
 576     }
 577
 578     @Override
 579     public synchronized void shutdownConnection() {
 580         LOG.debug("Shutdown method for node {}", deviceInfo.getNodeId());
 581         deviceState.setValid(false);
 582         if (DEVICE_CONTEXT_STATE.TERMINATION.equals(deviceCtxState)) {
 583             LOG.debug("DeviceCtx for Node {} is in termination process.", deviceInfo.getNodeId());
 584             return;
 585         }
 586         deviceCtxState = DEVICE_CONTEXT_STATE.TERMINATION;
 587
 588         if (ConnectionContext.CONNECTION_STATE.RIP.equals(getPrimaryConnectionContext().getConnectionState())) {
 589             LOG.debug("ConnectionCtx for Node {} is in RIP state.", deviceInfo.getNodeId());
 590             return;
 591         }
 592         /* Terminate Auxiliary Connection */
 593         for (final ConnectionContext connectionContext : auxiliaryConnectionContexts.values()) {
 594             LOG.debug("Closing auxiliary connection {}", connectionContext.getNodeId());
 595             connectionContext.closeConnection(false);
 596         }
 597         /* Terminate Primary Connection */
 598         getPrimaryConnectionContext().closeConnection(true);
 599         /* Close all Group Registry */
 600         deviceGroupRegistry.close();
 601         deviceFlowRegistry.close();
 602         deviceMeterRegistry.close();
 603     }
 604
 605     @Override
 606     public DEVICE_CONTEXT_STATE getDeviceContextState() {
 607         return deviceCtxState;
 608     }
 609
 610     @Override
 611     public ListenableFuture<Void> shuttingDownDataStoreTransactions() {
 612         deviceState.setValid(false);
 613         return transactionChainManager.shuttingDown();
 614     }
 615
 616     @VisibleForTesting
 617     TransactionChainManager getTransactionChainManager() {
 618         return this.transactionChainManager;
 619     }
 620 }