openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/DeviceContextImpl.java

   1 /**
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.openflowplugin.impl.device;
   9
  10 import com.google.common.annotations.VisibleForTesting;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.util.concurrent.CheckedFuture;
  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.HashedWheelTimer;
  17 import io.netty.util.Timeout;
  18 import java.math.BigInteger;
  19 import java.util.Collection;
  20 import java.util.Collections;
  21 import java.util.HashMap;
  22 import java.util.HashSet;
  23 import java.util.LinkedList;
  24 import java.util.List;
  25 import java.util.Map;
  26 import java.util.concurrent.ConcurrentHashMap;
  27 import javax.annotation.CheckForNull;
  28 import javax.annotation.Nonnull;
  29 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  30 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  31 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
  32 import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
  33 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  34 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  35 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
  36 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
  37 import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
  38 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  39 import org.opendaylight.openflowplugin.api.openflow.connection.OutboundQueueProvider;
  40 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  41 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  42 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
  43 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  44 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
  45 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  46 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceContextClosedHandler;
  47 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
  48 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
  49 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
  50 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
  51 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
  52 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowDescriptor;
  53 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowRegistryKey;
  54 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
  55 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
  56 import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleKeeper;
  57 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
  58 import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
  59 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  60 import org.opendaylight.openflowplugin.extension.api.ConvertorMessageFromOFJava;
  61 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterProviderKeeper;
  62 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
  63 import org.opendaylight.openflowplugin.extension.api.exception.ConversionException;
  64 import org.opendaylight.openflowplugin.extension.api.path.MessagePath;
  65 import org.opendaylight.openflowplugin.impl.common.ItemLifeCycleSourceImpl;
  66 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
  67 import org.opendaylight.openflowplugin.impl.device.listener.MultiMsgCollectorImpl;
  68 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
  69 import org.opendaylight.openflowplugin.impl.registry.flow.FlowRegistryKeyFactory;
  70 import org.opendaylight.openflowplugin.impl.registry.group.DeviceGroupRegistryImpl;
  71 import org.opendaylight.openflowplugin.impl.registry.meter.DeviceMeterRegistryImpl;
  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     public 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 HashedWheelTimer hashedWheelTimer;
 126     private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
 127     private final TransactionChainManager transactionChainManager;
 128     private final DeviceFlowRegistry deviceFlowRegistry;
 129     private final DeviceGroupRegistry deviceGroupRegistry;
 130     private final DeviceMeterRegistry deviceMeterRegistry;
 131     private final Collection<DeviceContextClosedHandler> closeHandlers = new HashSet<>();
 132     private final PacketInRateLimiter packetInLimiter;
 133     private final MessageSpy messageSpy;
 134     private final ItemLifeCycleKeeper flowLifeCycleKeeper;
 135     private NotificationPublishService notificationPublishService;
 136     private NotificationService notificationService;
 137     private final OutboundQueue outboundQueueProvider;
 138     private Timeout barrierTaskTimeout;
 139     private final MessageTranslator<PortGrouping, FlowCapableNodeConnector> portStatusTranslator;
 140     private final MessageTranslator<PacketInMessage, PacketReceived> packetInTranslator;
 141     private final MessageTranslator<FlowRemoved, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved> flowRemovedTranslator;
 142     private final TranslatorLibrary translatorLibrary;
 143     private final Map<Long, NodeConnectorRef> nodeConnectorCache;
 144     private final ItemLifeCycleRegistry itemLifeCycleSourceRegistry;
 145     private RpcContext rpcContext;
 146     private ExtensionConverterProvider extensionConverterProvider;
 147
 148
 149     @VisibleForTesting
 150     DeviceContextImpl(@Nonnull final ConnectionContext primaryConnectionContext,
 151                       @Nonnull final DeviceState deviceState,
 152                       @Nonnull final DataBroker dataBroker,
 153                       @Nonnull final HashedWheelTimer hashedWheelTimer,
 154                       @Nonnull final MessageSpy _messageSpy,
 155                       @Nonnull final OutboundQueueProvider outboundQueueProvider,
 156             @Nonnull final TranslatorLibrary translatorLibrary) {
 157         this.primaryConnectionContext = Preconditions.checkNotNull(primaryConnectionContext);
 158         this.deviceState = Preconditions.checkNotNull(deviceState);
 159         this.dataBroker = Preconditions.checkNotNull(dataBroker);
 160         this.hashedWheelTimer = Preconditions.checkNotNull(hashedWheelTimer);
 161         this.outboundQueueProvider = Preconditions.checkNotNull(outboundQueueProvider);
 162         primaryConnectionContext.setDeviceDisconnectedHandler(DeviceContextImpl.this);
 163         this.transactionChainManager = new TransactionChainManager(dataBroker, deviceState);
 164         auxiliaryConnectionContexts = new HashMap<>();
 165         deviceFlowRegistry = new DeviceFlowRegistryImpl();
 166         deviceGroupRegistry = new DeviceGroupRegistryImpl();
 167         deviceMeterRegistry = new DeviceMeterRegistryImpl();
 168         messageSpy = _messageSpy;
 169
 170         packetInLimiter = new PacketInRateLimiter(primaryConnectionContext.getConnectionAdapter(),
 171                 /*initial*/ 1000, /*initial*/2000, messageSpy, REJECTED_DRAIN_FACTOR);
 172
 173         this.translatorLibrary = translatorLibrary;
 174         portStatusTranslator = translatorLibrary.lookupTranslator(
 175                 new TranslatorKey(deviceState.getVersion(), PortGrouping.class.getName()));
 176         packetInTranslator = translatorLibrary.lookupTranslator(
 177                 new TranslatorKey(deviceState.getVersion(), PacketIn.class.getName()));
 178         flowRemovedTranslator = translatorLibrary.lookupTranslator(
 179                 new TranslatorKey(deviceState.getVersion(), FlowRemoved.class.getName()));
 180
 181
 182         nodeConnectorCache = new ConcurrentHashMap<>();
 183
 184         itemLifeCycleSourceRegistry = new ItemLifeCycleRegistryImpl();
 185         flowLifeCycleKeeper = new ItemLifeCycleSourceImpl();
 186         itemLifeCycleSourceRegistry.registerLifeCycleSource(flowLifeCycleKeeper);
 187     }
 188
 189     /**
 190      * This method is called from {@link DeviceManagerImpl} only. So we could say "posthandshake process finish"
 191      * and we are able to set a scheduler for an automatic transaction submitting by time (0,5sec).
 192      */
 193     void initialSubmitTransaction() {
 194         transactionChainManager.initialSubmitWriteTransaction();
 195     }
 196
 197     @Override
 198     public Long getReservedXid() {
 199         return outboundQueueProvider.reserveEntry();
 200     }
 201
 202     @Override
 203     public void addAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 204         final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
 205         auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
 206     }
 207
 208     private static SwitchConnectionDistinguisher createConnectionDistinguisher(final ConnectionContext connectionContext) {
 209         return new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
 210     }
 211
 212     @Override
 213     public void removeAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 214         // TODO Auto-generated method stub
 215     }
 216
 217     @Override
 218     public DeviceState getDeviceState() {
 219         return deviceState;
 220     }
 221
 222     @Override
 223     public ReadTransaction getReadTransaction() {
 224         return dataBroker.newReadOnlyTransaction();
 225     }
 226
 227     @Override
 228     public void onClusterRoleChange(@CheckForNull final OfpRole role) {
 229         LOG.debug("onClusterRoleChange {} for node:", role, deviceState.getNodeId());
 230         Preconditions.checkArgument(role != null);
 231         if (OfpRole.BECOMEMASTER.equals(role)) {
 232             transactionChainManager.activateTransactionManager();
 233         } else if (OfpRole.BECOMESLAVE.equals(role)) {
 234             transactionChainManager.deactivateTransactionManager();
 235         } else {
 236             LOG.warn("Unknow OFCluster Role {} for Node {}", role, deviceState.getNodeId());
 237         }
 238     }
 239
 240     @Override
 241     public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
 242                                                           final InstanceIdentifier<T> path, final T data) {
 243         transactionChainManager.writeToTransaction(store, path, data);
 244     }
 245
 246     @Override
 247     public <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path) {
 248         transactionChainManager.addDeleteOperationTotTxChain(store, path);
 249     }
 250
 251     @Override
 252     public boolean submitTransaction() {
 253         return transactionChainManager.submitWriteTransaction();
 254     }
 255
 256     @Override
 257     public ConnectionContext getPrimaryConnectionContext() {
 258         return primaryConnectionContext;
 259     }
 260
 261     @Override
 262     public ConnectionContext getAuxiliaryConnectiobContexts(final BigInteger cookie) {
 263         return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
 264     }
 265
 266     @Override
 267     public DeviceFlowRegistry getDeviceFlowRegistry() {
 268         return deviceFlowRegistry;
 269     }
 270
 271     @Override
 272     public DeviceGroupRegistry getDeviceGroupRegistry() {
 273         return deviceGroupRegistry;
 274     }
 275
 276     @Override
 277     public DeviceMeterRegistry getDeviceMeterRegistry() {
 278         return deviceMeterRegistry;
 279     }
 280
 281     @Override
 282     public void processReply(final OfHeader ofHeader) {
 283         if (ofHeader instanceof Error) {
 284             messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
 285         } else {
 286             messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 287         }
 288     }
 289
 290     @Override
 291     public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
 292         for (final MultipartReply multipartReply : ofHeaderList) {
 293             messageSpy.spyMessage(multipartReply.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
 294         }
 295     }
 296
 297     @Override
 298     public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
 299         final ItemLifecycleListener itemLifecycleListener = flowLifeCycleKeeper.getItemLifecycleListener();
 300         if (itemLifecycleListener != null) {
 301             //1. translate to general flow (table, priority, match, cookie)
 302             final org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved flowRemovedNotification =
 303                     flowRemovedTranslator.translate(flowRemoved, this, null);
 304             //2. create registry key
 305             final FlowRegistryKey flowRegKey = FlowRegistryKeyFactory.create(flowRemovedNotification);
 306             //3. lookup flowId
 307             final FlowDescriptor flowDescriptor = deviceFlowRegistry.retrieveIdForFlow(flowRegKey);
 308             //4. if flowId present:
 309             if (flowDescriptor != null) {
 310                 // a) construct flow path
 311                 final KeyedInstanceIdentifier<Flow, FlowKey> flowPath = getDeviceState().getNodeInstanceIdentifier()
 312                         .augmentation(FlowCapableNode.class)
 313                         .child(Table.class, flowDescriptor.getTableKey())
 314                         .child(Flow.class, new FlowKey(flowDescriptor.getFlowId()));
 315                 // b) notify listener
 316                 itemLifecycleListener.onRemoved(flowPath);
 317             } else {
 318                 LOG.debug("flow id not found: nodeId={} tableId={}, priority={}",
 319                         getDeviceState().getNodeId(), flowRegKey.getTableId(), flowRemovedNotification.getPriority());
 320             }
 321         }
 322     }
 323
 324     @Override
 325     public void processPortStatusMessage(final PortStatusMessage portStatus) {
 326         messageSpy.spyMessage(portStatus.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 327         final FlowCapableNodeConnector flowCapableNodeConnector = portStatusTranslator.translate(portStatus, this, null);
 328
 329         final KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> iiToNodeConnector = provideIIToNodeConnector(portStatus.getPortNo(), portStatus.getVersion());
 330         if (portStatus.getReason().equals(PortReason.OFPPRADD) || portStatus.getReason().equals(PortReason.OFPPRMODIFY)) {
 331             // because of ADD status node connector has to be created
 332             final NodeConnectorBuilder nConnectorBuilder = new NodeConnectorBuilder().setKey(iiToNodeConnector.getKey());
 333             nConnectorBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
 334             nConnectorBuilder.addAugmentation(FlowCapableNodeConnector.class, flowCapableNodeConnector);
 335             writeToTransaction(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector, nConnectorBuilder.build());
 336         } else if (portStatus.getReason().equals(PortReason.OFPPRDELETE)) {
 337             addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector);
 338         }
 339         submitTransaction();
 340     }
 341
 342     private KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> provideIIToNodeConnector(final long portNo, final short version) {
 343         final InstanceIdentifier<Node> iiToNodes = deviceState.getNodeInstanceIdentifier();
 344         final BigInteger dataPathId = deviceState.getFeatures().getDatapathId();
 345         final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), portNo, version);
 346         return iiToNodes.child(NodeConnector.class, new NodeConnectorKey(nodeConnectorId));
 347     }
 348
 349     @Override
 350     public void processPacketInMessage(final PacketInMessage packetInMessage) {
 351         messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH);
 352         final ConnectionAdapter connectionAdapter = getPrimaryConnectionContext().getConnectionAdapter();
 353         final PacketReceived packetReceived = packetInTranslator.translate(packetInMessage, this, null);
 354
 355         if (packetReceived == null) {
 356             LOG.debug("Received a null packet from switch {}", connectionAdapter.getRemoteAddress());
 357             messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_SRC_FAILURE);
 358             return;
 359         } else {
 360             messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_OUT_SUCCESS);
 361         }
 362
 363         if (!packetInLimiter.acquirePermit()) {
 364             LOG.debug("Packet limited");
 365             // TODO: save packet into emergency slot if possible
 366             messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PACKET_IN_LIMIT_REACHED_AND_DROPPED);
 367             return;
 368         }
 369
 370         final ListenableFuture<? extends Object> offerNotification = notificationPublishService.offerNotification(packetReceived);
 371         if (NotificationPublishService.REJECTED.equals(offerNotification)) {
 372             LOG.debug("notification offer rejected");
 373             messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
 374             packetInLimiter.drainLowWaterMark();
 375             packetInLimiter.releasePermit();
 376             return;
 377         }
 378
 379         Futures.addCallback(offerNotification, new FutureCallback<Object>() {
 380             @Override
 381             public void onSuccess(final Object result) {
 382                 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 383                 packetInLimiter.releasePermit();
 384             }
 385
 386             @Override
 387             public void onFailure(final Throwable t) {
 388                 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
 389                 LOG.debug("notification offer failed: {}", t.getMessage());
 390                 LOG.trace("notification offer failed..", t);
 391                 packetInLimiter.releasePermit();
 392             }
 393         });
 394     }
 395
 396     @Override
 397     public void processExperimenterMessage(final ExperimenterMessage notification) {
 398         // lookup converter
 399         final ExperimenterDataOfChoice vendorData = notification.getExperimenterDataOfChoice();
 400         final MessageTypeKey<? extends ExperimenterDataOfChoice> key = new MessageTypeKey<>(
 401                 deviceState.getVersion(),
 402                 (Class<? extends ExperimenterDataOfChoice>) vendorData.getImplementedInterface());
 403         final ConvertorMessageFromOFJava<ExperimenterDataOfChoice, MessagePath> messageConverter = extensionConverterProvider.getMessageConverter(key);
 404         if (messageConverter == null) {
 405             LOG.warn("custom converter for {}[OF:{}] not found",
 406                     notification.getExperimenterDataOfChoice().getImplementedInterface(),
 407                     deviceState.getVersion());
 408             return;
 409         }
 410         // build notification
 411         final ExperimenterMessageOfChoice messageOfChoice;
 412         try {
 413             messageOfChoice = messageConverter.convert(vendorData, MessagePath.MESSAGE_NOTIFICATION);
 414             final ExperimenterMessageFromDevBuilder experimenterMessageFromDevBld = new ExperimenterMessageFromDevBuilder()
 415                 .setNode(new NodeRef(deviceState.getNodeInstanceIdentifier()))
 416                     .setExperimenterMessageOfChoice(messageOfChoice);
 417             // publish
 418             notificationPublishService.offerNotification(experimenterMessageFromDevBld.build());
 419         } catch (final ConversionException e) {
 420             LOG.warn("Conversion of experimenter notification failed", e);
 421         }
 422     }
 423
 424     @Override
 425     public TranslatorLibrary oook() {
 426         return translatorLibrary;
 427     }
 428
 429     @Override
 430     public HashedWheelTimer getTimer() {
 431         return hashedWheelTimer;
 432     }
 433
 434     @Override
 435     public void close() {
 436         LOG.debug("closing deviceContext: {}, nodeId:{}",
 437                 getPrimaryConnectionContext().getConnectionAdapter().getRemoteAddress(),
 438                 getDeviceState().getNodeId());
 439
 440         tearDown();
 441
 442         primaryConnectionContext.closeConnection(false);
 443     }
 444
 445     private synchronized void tearDown() {
 446         LOG.trace("tearDown method for node {}", deviceState.getNodeId());
 447         if (deviceState.isValid()) {
 448             deviceState.setValid(false);
 449
 450             for (final ConnectionContext connectionContext : auxiliaryConnectionContexts.values()) {
 451                 connectionContext.closeConnection(false);
 452             }
 453
 454             deviceGroupRegistry.close();
 455             deviceFlowRegistry.close();
 456             deviceMeterRegistry.close();
 457
 458             final CheckedFuture<Void, TransactionCommitFailedException> future = transactionChainManager.shuttingDown();
 459             Futures.addCallback(future, new FutureCallback<Void>() {
 460
 461                 @Override
 462                 public void onSuccess(final Void result) {
 463                     LOG.info("Delete Node {} was successfull.", deviceState.getNodeId());
 464                     tearDownClean();
 465                 }
 466
 467                 @Override
 468                 public void onFailure(final Throwable t) {
 469                     LOG.warn("Delete Node {} fail.", deviceState.getNodeId(), t);
 470                     tearDownClean();
 471                 }
 472             });
 473         }
 474     }
 475
 476     synchronized void tearDownClean() {
 477         LOG.info("Closing transaction chain manager without cleaning inventory operational");
 478         Preconditions.checkState(!deviceState.isValid());
 479         transactionChainManager.close();
 480
 481         final LinkedList<DeviceContextClosedHandler> reversedCloseHandlers = new LinkedList<>(closeHandlers);
 482         Collections.reverse(reversedCloseHandlers);
 483         for (final DeviceContextClosedHandler deviceContextClosedHandler : reversedCloseHandlers) {
 484             deviceContextClosedHandler.onDeviceContextClosed(this);
 485         }
 486         closeHandlers.clear();
 487     }
 488
 489     @Override
 490     public void onDeviceDisconnected(final ConnectionContext connectionContext) {
 491         if (getPrimaryConnectionContext().equals(connectionContext)) {
 492             try {
 493                 tearDown();
 494             } catch (final Exception e) {
 495                 LOG.trace("Error closing device context.");
 496             }
 497         } else {
 498             LOG.debug("auxiliary connection dropped: {}, nodeId:{}",
 499                     connectionContext.getConnectionAdapter().getRemoteAddress(),
 500                     getDeviceState().getNodeId());
 501             final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
 502             auxiliaryConnectionContexts.remove(connectionDistinguisher);
 503         }
 504     }
 505
 506     @Override
 507     public void setCurrentBarrierTimeout(final Timeout timeout) {
 508         barrierTaskTimeout = timeout;
 509     }
 510
 511     @Override
 512     public Timeout getBarrierTaskTimeout() {
 513         return barrierTaskTimeout;
 514     }
 515
 516     @Override
 517     public void setNotificationService(final NotificationService notificationServiceParam) {
 518         notificationService = notificationServiceParam;
 519     }
 520
 521     @Override
 522     public void setNotificationPublishService(final NotificationPublishService notificationPublishService) {
 523         this.notificationPublishService = notificationPublishService;
 524     }
 525
 526     @Override
 527     public MessageSpy getMessageSpy() {
 528         return messageSpy;
 529     }
 530
 531     @Override
 532     public void addDeviceContextClosedHandler(final DeviceContextClosedHandler deviceContextClosedHandler) {
 533         closeHandlers.add(deviceContextClosedHandler);
 534     }
 535
 536     @Override
 537     public void onPublished() {
 538         primaryConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
 539         for (final ConnectionContext switchAuxConnectionContext : auxiliaryConnectionContexts.values()) {
 540             switchAuxConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
 541         }
 542     }
 543
 544     @Override
 545     public MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext) {
 546         return new MultiMsgCollectorImpl(this, requestContext);
 547     }
 548
 549     @Override
 550     public NodeConnectorRef lookupNodeConnectorRef(final Long portNumber) {
 551         return nodeConnectorCache.get(portNumber);
 552     }
 553
 554     @Override
 555     public void storeNodeConnectorRef(final Long portNumber, final NodeConnectorRef nodeConnectorRef) {
 556         nodeConnectorCache.put(
 557                 Preconditions.checkNotNull(portNumber),
 558                 Preconditions.checkNotNull(nodeConnectorRef));
 559     }
 560
 561     @Override
 562     public void updatePacketInRateLimit(final long upperBound) {
 563         packetInLimiter.changeWaterMarks((int) (LOW_WATERMARK_FACTOR * upperBound), (int) (HIGH_WATERMARK_FACTOR * upperBound));
 564     }
 565
 566     @Override
 567     public ItemLifeCycleRegistry getItemLifeCycleSourceRegistry() {
 568         return itemLifeCycleSourceRegistry;
 569     }
 570
 571     @Override
 572     public void setRpcContext(final RpcContext rpcContext) {
 573         this.rpcContext = rpcContext;
 574     }
 575
 576     @Override
 577     public RpcContext getRpcContext() {
 578         return rpcContext;
 579     }
 580
 581     @Override
 582     public void setExtensionConverterProvider(final ExtensionConverterProvider extensionConverterProvider) {
 583         this.extensionConverterProvider = extensionConverterProvider;
 584     }
 585
 586     @Override
 587     public ExtensionConverterProvider getExtensionConverterProvider() {
 588         return extensionConverterProvider;
 589     }
 590 }