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