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