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