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