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