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