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