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