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

   1 /**
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.openflowplugin.impl.device;
   9
  10 import com.google.common.annotations.VisibleForTesting;
  11 import com.google.common.base.Function;
  12 import com.google.common.base.Optional;
  13 import com.google.common.base.Preconditions;
  14 import com.google.common.util.concurrent.AsyncFunction;
  15 import com.google.common.util.concurrent.CheckedFuture;
  16 import com.google.common.util.concurrent.FutureCallback;
  17 import com.google.common.util.concurrent.Futures;
  18 import com.google.common.util.concurrent.ListenableFuture;
  19 import io.netty.util.HashedWheelTimer;
  20 import io.netty.util.Timeout;
  21 import java.math.BigInteger;
  22 import java.util.Collection;
  23 import java.util.Collections;
  24 import java.util.HashMap;
  25 import java.util.HashSet;
  26 import java.util.LinkedList;
  27 import java.util.List;
  28 import java.util.Map;
  29 import java.util.concurrent.ConcurrentHashMap;
  30 import javax.annotation.CheckForNull;
  31 import javax.annotation.Nonnull;
  32 import javax.annotation.Nullable;
  33 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  34 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  35 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
  36 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  37 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  38 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  39 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  40 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
  41 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
  42 import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
  43 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  44 import org.opendaylight.openflowplugin.api.openflow.connection.OutboundQueueProvider;
  45 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  46 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  47 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
  48 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  49 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
  50 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  51 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceContextClosedHandler;
  52 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
  53 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
  54 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
  55 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
  56 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
  57 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowDescriptor;
  58 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowRegistryKey;
  59 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
  60 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
  61 import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleKeeper;
  62 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
  63 import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
  64 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
  65 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  66 import org.opendaylight.openflowplugin.extension.api.ConvertorMessageFromOFJava;
  67 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterProviderKeeper;
  68 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
  69 import org.opendaylight.openflowplugin.extension.api.exception.ConversionException;
  70 import org.opendaylight.openflowplugin.extension.api.path.MessagePath;
  71 import org.opendaylight.openflowplugin.impl.common.ItemLifeCycleSourceImpl;
  72 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
  73 import org.opendaylight.openflowplugin.impl.device.listener.MultiMsgCollectorImpl;
  74 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
  75 import org.opendaylight.openflowplugin.impl.registry.flow.FlowRegistryKeyFactory;
  76 import org.opendaylight.openflowplugin.impl.registry.group.DeviceGroupRegistryImpl;
  77 import org.opendaylight.openflowplugin.impl.registry.meter.DeviceMeterRegistryImpl;
  78 import org.opendaylight.openflowplugin.impl.util.DeviceInitializationUtils;
  79 import org.opendaylight.openflowplugin.impl.util.MdSalRegistratorUtils;
  80 import org.opendaylight.openflowplugin.openflow.md.core.session.SwitchConnectionCookieOFImpl;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.experimenter.message.service.rev151020.ExperimenterMessageFromDevBuilder;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortReason;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
  97 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
  98 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  99 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
 100 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketIn;
 101 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
 102 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
 103 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
 104 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.experimenter.core.ExperimenterDataOfChoice;
 105 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.experimenter.types.rev151020.experimenter.core.message.ExperimenterMessageOfChoice;
 106 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
 107 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
 108 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
 109 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
 110 import org.opendaylight.yangtools.yang.binding.DataObject;
 111 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 112 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
 113 import org.slf4j.Logger;
 114 import org.slf4j.LoggerFactory;
 115
 116 /**
 117  *
 118  */
 119 public class DeviceContextImpl implements DeviceContext, ExtensionConverterProviderKeeper {
 120
 121     private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
 122
 123     // TODO: drain factor should be parametrized
 124     public static final float REJECTED_DRAIN_FACTOR = 0.25f;
 125     // TODO: low water mark factor should be parametrized
 126     private static final float LOW_WATERMARK_FACTOR = 0.75f;
 127     // TODO: high water mark factor should be parametrized
 128     private static final float HIGH_WATERMARK_FACTOR = 0.95f;
 129
 130     private final ConnectionContext primaryConnectionContext;
 131     private final DeviceState deviceState;
 132     private final DataBroker dataBroker;
 133     private final HashedWheelTimer hashedWheelTimer;
 134     private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
 135     private final TransactionChainManager transactionChainManager;
 136     private final DeviceFlowRegistry deviceFlowRegistry;
 137     private final DeviceGroupRegistry deviceGroupRegistry;
 138     private final DeviceMeterRegistry deviceMeterRegistry;
 139     private final Collection<DeviceContextClosedHandler> closeHandlers = new HashSet<>();
 140     private final PacketInRateLimiter packetInLimiter;
 141     private final MessageSpy messageSpy;
 142     private final ItemLifeCycleKeeper flowLifeCycleKeeper;
 143     private NotificationPublishService notificationPublishService;
 144     private NotificationService notificationService;
 145     private final OutboundQueue outboundQueueProvider;
 146     private Timeout barrierTaskTimeout;
 147     private final MessageTranslator<PortGrouping, FlowCapableNodeConnector> portStatusTranslator;
 148     private final MessageTranslator<PacketInMessage, PacketReceived> packetInTranslator;
 149     private final MessageTranslator<FlowRemoved, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved> flowRemovedTranslator;
 150     private final TranslatorLibrary translatorLibrary;
 151     private final Map<Long, NodeConnectorRef> nodeConnectorCache;
 152     private final ItemLifeCycleRegistry itemLifeCycleSourceRegistry;
 153     private RpcContext rpcContext;
 154     private ExtensionConverterProvider extensionConverterProvider;
 155
 156     private final boolean switchFeaturesMandatory;
 157     private StatisticsContext statCtx;
 158
 159
 160     @VisibleForTesting
 161     DeviceContextImpl(@Nonnull final ConnectionContext primaryConnectionContext,
 162                       @Nonnull final DeviceState deviceState,
 163                       @Nonnull final DataBroker dataBroker,
 164                       @Nonnull final HashedWheelTimer hashedWheelTimer,
 165                       @Nonnull final MessageSpy _messageSpy,
 166                       @Nonnull final OutboundQueueProvider outboundQueueProvider,
 167                       @Nonnull final TranslatorLibrary translatorLibrary,
 168                       final boolean switchFeaturesMandatory) {
 169         this.switchFeaturesMandatory = switchFeaturesMandatory;
 170         this.primaryConnectionContext = Preconditions.checkNotNull(primaryConnectionContext);
 171         this.deviceState = Preconditions.checkNotNull(deviceState);
 172         this.dataBroker = Preconditions.checkNotNull(dataBroker);
 173         this.hashedWheelTimer = Preconditions.checkNotNull(hashedWheelTimer);
 174         this.outboundQueueProvider = Preconditions.checkNotNull(outboundQueueProvider);
 175         primaryConnectionContext.setDeviceDisconnectedHandler(DeviceContextImpl.this);
 176         this.transactionChainManager = new TransactionChainManager(dataBroker, deviceState);
 177         auxiliaryConnectionContexts = new HashMap<>();
 178         deviceFlowRegistry = new DeviceFlowRegistryImpl();
 179         deviceGroupRegistry = new DeviceGroupRegistryImpl();
 180         deviceMeterRegistry = new DeviceMeterRegistryImpl();
 181         messageSpy = _messageSpy;
 182
 183         packetInLimiter = new PacketInRateLimiter(primaryConnectionContext.getConnectionAdapter(),
 184                 /*initial*/ 1000, /*initial*/2000, messageSpy, REJECTED_DRAIN_FACTOR);
 185
 186         this.translatorLibrary = translatorLibrary;
 187         portStatusTranslator = translatorLibrary.lookupTranslator(
 188                 new TranslatorKey(deviceState.getVersion(), PortGrouping.class.getName()));
 189         packetInTranslator = translatorLibrary.lookupTranslator(
 190                 new TranslatorKey(deviceState.getVersion(), PacketIn.class.getName()));
 191         flowRemovedTranslator = translatorLibrary.lookupTranslator(
 192                 new TranslatorKey(deviceState.getVersion(), FlowRemoved.class.getName()));
 193
 194
 195         nodeConnectorCache = new ConcurrentHashMap<>();
 196
 197         itemLifeCycleSourceRegistry = new ItemLifeCycleRegistryImpl();
 198         flowLifeCycleKeeper = new ItemLifeCycleSourceImpl();
 199         itemLifeCycleSourceRegistry.registerLifeCycleSource(flowLifeCycleKeeper);
 200     }
 201
 202     /**
 203      * This method is called from {@link DeviceManagerImpl} only. So we could say "posthandshake process finish"
 204      * and we are able to set a scheduler for an automatic transaction submitting by time (0,5sec).
 205      */
 206     void initialSubmitTransaction() {
 207         transactionChainManager.initialSubmitWriteTransaction();
 208     }
 209
 210     @Override
 211     public Long reservedXidForDeviceMessage() {
 212         return outboundQueueProvider.reserveEntry();
 213     }
 214
 215     @Override
 216     public void addAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 217         final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
 218         auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
 219     }
 220
 221     private static SwitchConnectionDistinguisher createConnectionDistinguisher(final ConnectionContext connectionContext) {
 222         return new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
 223     }
 224
 225     @Override
 226     public void removeAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 227         // TODO Auto-generated method stub
 228     }
 229
 230     @Override
 231     public DeviceState getDeviceState() {
 232         return deviceState;
 233     }
 234
 235     @Override
 236     public ReadOnlyTransaction getReadTransaction() {
 237         return dataBroker.newReadOnlyTransaction();
 238     }
 239
 240     @Override
 241     public ListenableFuture<Void> onClusterRoleChange(final OfpRole oldRole, @CheckForNull final OfpRole role) {
 242         LOG.trace("onClusterRoleChange {} for node:", role, deviceState.getNodeId());
 243         Preconditions.checkArgument(role != null);
 244         if (role.equals(oldRole)) {
 245             LOG.debug("Demanded role change for device {} is not change OldRole: {}, NewRole {}", deviceState.getNodeId(), oldRole, role);
 246             return Futures.immediateFuture(null);
 247         }
 248         if (OfpRole.BECOMEMASTER.equals(role)) {
 249             if (!deviceState.deviceSynchronized()) {
 250                 LOG.debug("Setup Device Ctx {} for Master Role", getDeviceState().getNodeId());
 251                 transactionChainManager.activateTransactionManager();
 252                 return Futures.immediateCheckedFuture(null);
 253             }
 254             /* Relevant for no initial Slave-to-Master scenario in cluster */
 255             return asyncClusterRoleChange(role);
 256         } else if (OfpRole.BECOMESLAVE.equals(role)) {
 257             if (rpcContext != null) {
 258                 MdSalRegistratorUtils.registerSlaveServices(rpcContext, role);
 259             }
 260             return transactionChainManager.deactivateTransactionManager();
 261         } else {
 262             LOG.warn("Unknown OFCluster Role {} for Node {}", role, deviceState.getNodeId());
 263             if (rpcContext != null) {
 264                 MdSalRegistratorUtils.unregisterServices(rpcContext);
 265             }
 266             return transactionChainManager.deactivateTransactionManager();
 267         }
 268     }
 269
 270     /*
 271      * we don't have active TxManager so anything will not be stored to DS yet, but we have
 272      * check all NodeInformation for statistics otherwise statistics will not contains
 273      * all possible MultipartTypes for polling in StatTypeList
 274      */
 275     private ListenableFuture<Void> asyncClusterRoleChange(final OfpRole role) {
 276         if (statCtx == null) {
 277             final String errMsg = String.format("DeviceCtx {} is up but we are missing StatisticsContext", deviceState.getNodeId());
 278             LOG.warn(errMsg);
 279             return Futures.immediateFailedFuture(new IllegalStateException(errMsg));
 280         }
 281
 282         final InstanceIdentifier<FlowCapableNode> ofNodeII = deviceState.getNodeInstanceIdentifier()
 283                 .augmentation(FlowCapableNode.class);
 284         final ReadOnlyTransaction readTx = getReadTransaction();
 285         final CheckedFuture<Optional<FlowCapableNode>, ReadFailedException> readOfNodeFuture = readTx.read(
 286                 LogicalDatastoreType.OPERATIONAL, ofNodeII);
 287
 288         final ListenableFuture<Void> nodeInitInfoFuture = Futures.transform(readOfNodeFuture,
 289                 new AsyncFunction<Optional<FlowCapableNode>, Void>() {
 290                     @Override
 291                     public ListenableFuture<Void> apply(final Optional<FlowCapableNode> input) throws Exception {
 292                         if (!input.isPresent() || input.get().getTable().isEmpty()) {
 293                             /* Last master close fail scenario so we would like to activate TxManager */
 294                             LOG.debug("Operational DS for Device {} has to be replaced", deviceState.getNodeId());
 295                             getDeviceState().setDeviceSynchronized(false);
 296                             transactionChainManager.activateTransactionManager();
 297                         }
 298                         return DeviceInitializationUtils.initializeNodeInformation(DeviceContextImpl.this, switchFeaturesMandatory);
 299                     }
 300                 });
 301
 302         final ListenableFuture<Boolean> statPollFuture = Futures.transform(nodeInitInfoFuture,
 303                 new AsyncFunction<Void, Boolean>() {
 304
 305                     @Override
 306                     public ListenableFuture<Boolean> apply(final Void input) throws Exception {
 307                         getStatisticsContext().statListForCollectingInitialization();
 308                         if (getDeviceState().deviceSynchronized()) {
 309                             return Futures.immediateFuture(Boolean.TRUE);
 310                         }
 311                         return getStatisticsContext().gatherDynamicData();
 312                     }
 313                 });
 314
 315         return Futures.transform(statPollFuture, new Function<Boolean, Void>() {
 316
 317             @Override
 318             public Void apply(final Boolean input) {
 319                 if (!input.booleanValue()) {
 320                     LOG.warn("Get Initial Device {} information fails", getDeviceState().getNodeId());
 321                     DeviceContextImpl.this.close();
 322                     return null;
 323                 }
 324                 LOG.debug("Get Initial Device {} information is successful", getDeviceState().getNodeId());
 325                 if (null != getRpcContext()) {
 326                     MdSalRegistratorUtils.registerMasterServices(getRpcContext(), DeviceContextImpl.this, role);
 327                 }
 328                 getDeviceState().setDeviceSynchronized(true);
 329                 getDeviceState().setStatisticsPollingEnabledProp(true);
 330                 transactionChainManager.activateTransactionManager();
 331                 return null;
 332             }
 333         });
 334     }
 335
 336     @Override
 337     public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
 338                                                           final InstanceIdentifier<T> path, final T data) {
 339         transactionChainManager.writeToTransaction(store, path, data);
 340     }
 341
 342     @Override
 343     public <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path) {
 344         transactionChainManager.addDeleteOperationTotTxChain(store, path);
 345     }
 346
 347     @Override
 348     public boolean submitTransaction() {
 349         return transactionChainManager.submitWriteTransaction();
 350     }
 351
 352     @Override
 353     public ConnectionContext getPrimaryConnectionContext() {
 354         return primaryConnectionContext;
 355     }
 356
 357     @Override
 358     public ConnectionContext getAuxiliaryConnectiobContexts(final BigInteger cookie) {
 359         return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
 360     }
 361
 362     @Override
 363     public DeviceFlowRegistry getDeviceFlowRegistry() {
 364         return deviceFlowRegistry;
 365     }
 366
 367     @Override
 368     public DeviceGroupRegistry getDeviceGroupRegistry() {
 369         return deviceGroupRegistry;
 370     }
 371
 372     @Override
 373     public DeviceMeterRegistry getDeviceMeterRegistry() {
 374         return deviceMeterRegistry;
 375     }
 376
 377     @Override
 378     public void processReply(final OfHeader ofHeader) {
 379         if (ofHeader instanceof Error) {
 380             messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
 381         } else {
 382             messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 383         }
 384     }
 385
 386     @Override
 387     public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
 388         for (final MultipartReply multipartReply : ofHeaderList) {
 389             messageSpy.spyMessage(multipartReply.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
 390         }
 391     }
 392
 393     @Override
 394     public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
 395         final ItemLifecycleListener itemLifecycleListener = flowLifeCycleKeeper.getItemLifecycleListener();
 396         if (itemLifecycleListener != null) {
 397             //1. translate to general flow (table, priority, match, cookie)
 398             final org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved flowRemovedNotification =
 399                     flowRemovedTranslator.translate(flowRemoved, this, null);
 400             //2. create registry key
 401             final FlowRegistryKey flowRegKey = FlowRegistryKeyFactory.create(flowRemovedNotification);
 402             //3. lookup flowId
 403             final FlowDescriptor flowDescriptor = deviceFlowRegistry.retrieveIdForFlow(flowRegKey);
 404             //4. if flowId present:
 405             if (flowDescriptor != null) {
 406                 // a) construct flow path
 407                 final KeyedInstanceIdentifier<Flow, FlowKey> flowPath = getDeviceState().getNodeInstanceIdentifier()
 408                         .augmentation(FlowCapableNode.class)
 409                         .child(Table.class, flowDescriptor.getTableKey())
 410                         .child(Flow.class, new FlowKey(flowDescriptor.getFlowId()));
 411                 // b) notify listener
 412                 itemLifecycleListener.onRemoved(flowPath);
 413             } else {
 414                 LOG.debug("flow id not found: nodeId={} tableId={}, priority={}",
 415                         getDeviceState().getNodeId(), flowRegKey.getTableId(), flowRemovedNotification.getPriority());
 416             }
 417         }
 418     }
 419
 420     @Override
 421     public void processPortStatusMessage(final PortStatusMessage portStatus) {
 422         messageSpy.spyMessage(portStatus.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 423         final FlowCapableNodeConnector flowCapableNodeConnector = portStatusTranslator.translate(portStatus, this, null);
 424
 425         final KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> iiToNodeConnector = provideIIToNodeConnector(portStatus.getPortNo(), portStatus.getVersion());
 426         if (portStatus.getReason().equals(PortReason.OFPPRADD) || portStatus.getReason().equals(PortReason.OFPPRMODIFY)) {
 427             // because of ADD status node connector has to be created
 428             final NodeConnectorBuilder nConnectorBuilder = new NodeConnectorBuilder().setKey(iiToNodeConnector.getKey());
 429             nConnectorBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
 430             nConnectorBuilder.addAugmentation(FlowCapableNodeConnector.class, flowCapableNodeConnector);
 431             writeToTransaction(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector, nConnectorBuilder.build());
 432         } else if (portStatus.getReason().equals(PortReason.OFPPRDELETE)) {
 433             addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector);
 434         }
 435         submitTransaction();
 436     }
 437
 438     private KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> provideIIToNodeConnector(final long portNo, final short version) {
 439         final InstanceIdentifier<Node> iiToNodes = deviceState.getNodeInstanceIdentifier();
 440         final BigInteger dataPathId = deviceState.getFeatures().getDatapathId();
 441         final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), portNo, version);
 442         return iiToNodes.child(NodeConnector.class, new NodeConnectorKey(nodeConnectorId));
 443     }
 444
 445     @Override
 446     public void processPacketInMessage(final PacketInMessage packetInMessage) {
 447         messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH);
 448         final ConnectionAdapter connectionAdapter = getPrimaryConnectionContext().getConnectionAdapter();
 449         final PacketReceived packetReceived = packetInTranslator.translate(packetInMessage, this, null);
 450
 451         if (packetReceived == null) {
 452             LOG.debug("Received a null packet from switch {}", connectionAdapter.getRemoteAddress());
 453             messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_SRC_FAILURE);
 454             return;
 455         } else {
 456             messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_OUT_SUCCESS);
 457         }
 458
 459         if (!packetInLimiter.acquirePermit()) {
 460             LOG.debug("Packet limited");
 461             // TODO: save packet into emergency slot if possible
 462             messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PACKET_IN_LIMIT_REACHED_AND_DROPPED);
 463             return;
 464         }
 465
 466         final ListenableFuture<? extends Object> offerNotification = notificationPublishService.offerNotification(packetReceived);
 467         if (NotificationPublishService.REJECTED.equals(offerNotification)) {
 468             LOG.debug("notification offer rejected");
 469             messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
 470             packetInLimiter.drainLowWaterMark();
 471             packetInLimiter.releasePermit();
 472             return;
 473         }
 474
 475         Futures.addCallback(offerNotification, new FutureCallback<Object>() {
 476             @Override
 477             public void onSuccess(final Object result) {
 478                 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 479                 packetInLimiter.releasePermit();
 480             }
 481
 482             @Override
 483             public void onFailure(final Throwable t) {
 484                 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
 485                 LOG.debug("notification offer failed: {}", t.getMessage());
 486                 LOG.trace("notification offer failed..", t);
 487                 packetInLimiter.releasePermit();
 488             }
 489         });
 490     }
 491
 492     @Override
 493     public void processExperimenterMessage(final ExperimenterMessage notification) {
 494         // lookup converter
 495         final ExperimenterDataOfChoice vendorData = notification.getExperimenterDataOfChoice();
 496         final MessageTypeKey<? extends ExperimenterDataOfChoice> key = new MessageTypeKey<>(
 497                 deviceState.getVersion(),
 498                 (Class<? extends ExperimenterDataOfChoice>) vendorData.getImplementedInterface());
 499         final ConvertorMessageFromOFJava<ExperimenterDataOfChoice, MessagePath> messageConverter = extensionConverterProvider.getMessageConverter(key);
 500         if (messageConverter == null) {
 501             LOG.warn("custom converter for {}[OF:{}] not found",
 502                     notification.getExperimenterDataOfChoice().getImplementedInterface(),
 503                     deviceState.getVersion());
 504             return;
 505         }
 506         // build notification
 507         final ExperimenterMessageOfChoice messageOfChoice;
 508         try {
 509             messageOfChoice = messageConverter.convert(vendorData, MessagePath.MESSAGE_NOTIFICATION);
 510             final ExperimenterMessageFromDevBuilder experimenterMessageFromDevBld = new ExperimenterMessageFromDevBuilder()
 511                 .setNode(new NodeRef(deviceState.getNodeInstanceIdentifier()))
 512                     .setExperimenterMessageOfChoice(messageOfChoice);
 513             // publish
 514             notificationPublishService.offerNotification(experimenterMessageFromDevBld.build());
 515         } catch (final ConversionException e) {
 516             LOG.warn("Conversion of experimenter notification failed", e);
 517         }
 518     }
 519
 520     @Override
 521     public TranslatorLibrary oook() {
 522         return translatorLibrary;
 523     }
 524
 525     @Override
 526     public HashedWheelTimer getTimer() {
 527         return hashedWheelTimer;
 528     }
 529
 530     @Override
 531     public void close() {
 532         LOG.debug("closing deviceContext: {}, nodeId:{}",
 533                 getPrimaryConnectionContext().getConnectionAdapter().getRemoteAddress(),
 534                 getDeviceState().getNodeId());
 535
 536         tearDown();
 537
 538         primaryConnectionContext.closeConnection(false);
 539     }
 540
 541     private synchronized void tearDown() {
 542         LOG.trace("tearDown method for node {}", deviceState.getNodeId());
 543         if (deviceState.isValid()) {
 544             deviceState.setValid(false);
 545
 546             for (final ConnectionContext connectionContext : auxiliaryConnectionContexts.values()) {
 547                 connectionContext.closeConnection(false);
 548             }
 549
 550             deviceGroupRegistry.close();
 551             deviceFlowRegistry.close();
 552             deviceMeterRegistry.close();
 553
 554             final CheckedFuture<Void, TransactionCommitFailedException> future = transactionChainManager.shuttingDown();
 555             Futures.addCallback(future, new FutureCallback<Void>() {
 556
 557                 @Override
 558                 public void onSuccess(final Void result) {
 559                     LOG.info("TxChain {} was shutdown successfull.", deviceState.getNodeId());
 560                     tearDownClean();
 561                 }
 562
 563                 @Override
 564                 public void onFailure(final Throwable t) {
 565                     LOG.warn("Shutdown TxChain {} fail.", deviceState.getNodeId(), t);
 566                     tearDownClean();
 567                 }
 568             });
 569         }
 570     }
 571
 572     synchronized void tearDownClean() {
 573         LOG.info("Closing transaction chain manager without cleaning inventory operational");
 574         Preconditions.checkState(!deviceState.isValid());
 575         transactionChainManager.close();
 576
 577         final LinkedList<DeviceContextClosedHandler> reversedCloseHandlers = new LinkedList<>(closeHandlers);
 578         Collections.reverse(reversedCloseHandlers);
 579         for (final DeviceContextClosedHandler deviceContextClosedHandler : reversedCloseHandlers) {
 580             deviceContextClosedHandler.onDeviceContextClosed(this);
 581         }
 582         closeHandlers.clear();
 583     }
 584
 585     @Override
 586     public void onDeviceDisconnected(final ConnectionContext connectionContext) {
 587         if (getPrimaryConnectionContext().equals(connectionContext)) {
 588             try {
 589                 tearDown();
 590             } catch (final Exception e) {
 591                 LOG.trace("Error closing device context.");
 592             }
 593         } else {
 594             LOG.debug("auxiliary connection dropped: {}, nodeId:{}",
 595                     connectionContext.getConnectionAdapter().getRemoteAddress(),
 596                     getDeviceState().getNodeId());
 597             final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
 598             auxiliaryConnectionContexts.remove(connectionDistinguisher);
 599         }
 600     }
 601
 602     @Override
 603     public void setCurrentBarrierTimeout(final Timeout timeout) {
 604         barrierTaskTimeout = timeout;
 605     }
 606
 607     @Override
 608     public Timeout getBarrierTaskTimeout() {
 609         return barrierTaskTimeout;
 610     }
 611
 612     @Override
 613     public void setNotificationService(final NotificationService notificationServiceParam) {
 614         notificationService = notificationServiceParam;
 615     }
 616
 617     @Override
 618     public void setNotificationPublishService(final NotificationPublishService notificationPublishService) {
 619         this.notificationPublishService = notificationPublishService;
 620     }
 621
 622     @Override
 623     public MessageSpy getMessageSpy() {
 624         return messageSpy;
 625     }
 626
 627     @Override
 628     public void addDeviceContextClosedHandler(final DeviceContextClosedHandler deviceContextClosedHandler) {
 629         closeHandlers.add(deviceContextClosedHandler);
 630     }
 631
 632     @Override
 633     public void onPublished() {
 634         primaryConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
 635         for (final ConnectionContext switchAuxConnectionContext : auxiliaryConnectionContexts.values()) {
 636             switchAuxConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
 637         }
 638     }
 639
 640     @Override
 641     public MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext) {
 642         return new MultiMsgCollectorImpl(this, requestContext);
 643     }
 644
 645     @Override
 646     public NodeConnectorRef lookupNodeConnectorRef(final Long portNumber) {
 647         return nodeConnectorCache.get(portNumber);
 648     }
 649
 650     @Override
 651     public void storeNodeConnectorRef(final Long portNumber, final NodeConnectorRef nodeConnectorRef) {
 652         nodeConnectorCache.put(
 653                 Preconditions.checkNotNull(portNumber),
 654                 Preconditions.checkNotNull(nodeConnectorRef));
 655     }
 656
 657     @Override
 658     public void updatePacketInRateLimit(final long upperBound) {
 659         packetInLimiter.changeWaterMarks((int) (LOW_WATERMARK_FACTOR * upperBound), (int) (HIGH_WATERMARK_FACTOR * upperBound));
 660     }
 661
 662     @Override
 663     public ItemLifeCycleRegistry getItemLifeCycleSourceRegistry() {
 664         return itemLifeCycleSourceRegistry;
 665     }
 666
 667     @Override
 668     public void setRpcContext(final RpcContext rpcContext) {
 669         this.rpcContext = rpcContext;
 670     }
 671
 672     @Override
 673     public RpcContext getRpcContext() {
 674         return rpcContext;
 675     }
 676
 677     @Override
 678     public void setExtensionConverterProvider(final ExtensionConverterProvider extensionConverterProvider) {
 679         this.extensionConverterProvider = extensionConverterProvider;
 680     }
 681
 682     @Override
 683     public ExtensionConverterProvider getExtensionConverterProvider() {
 684         return extensionConverterProvider;
 685     }
 686
 687     @Override
 688     public void setStatisticsContext(final StatisticsContext statisticsContext) {
 689         this.statCtx = statisticsContext;
 690     }
 691
 692     @Override
 693     public StatisticsContext getStatisticsContext() {
 694         return statCtx;
 695     }
 696 }