openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/DeviceManagerImpl.java

   1 /**
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.openflowplugin.impl.device;
   9
  10 import com.google.common.annotations.VisibleForTesting;
  11 import com.google.common.base.Function;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.base.Verify;
  14 import com.google.common.collect.Iterators;
  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.ListenableFuture;
  19 import io.netty.util.TimerTask;
  20 import java.util.Collections;
  21 import java.util.HashSet;
  22 import java.util.Iterator;
  23 import java.util.Set;
  24 import java.util.concurrent.ConcurrentHashMap;
  25 import java.util.concurrent.ConcurrentMap;
  26 import java.util.concurrent.ExecutionException;
  27 import java.util.concurrent.ScheduledThreadPoolExecutor;
  28 import java.util.concurrent.TimeUnit;
  29 import javax.annotation.CheckForNull;
  30 import javax.annotation.Nonnull;
  31 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  32 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  33 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  34 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
  35 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueueHandlerRegistration;
  36 import org.opendaylight.openflowplugin.api.openflow.OFPContext;
  37 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  38 import org.opendaylight.openflowplugin.api.openflow.connection.OutboundQueueProvider;
  39 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  40 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  41 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
  42 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  43 import org.opendaylight.openflowplugin.api.openflow.device.DeviceSynchronizeListener;
  44 import org.opendaylight.openflowplugin.api.openflow.device.DeviceValidListener;
  45 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
  46 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
  47 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
  48 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleConductor;
  49 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
  50 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterProviderKeeper;
  51 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
  52 import org.opendaylight.openflowplugin.impl.connection.OutboundQueueProviderImpl;
  53 import org.opendaylight.openflowplugin.impl.device.listener.OpenflowProtocolListenerFullImpl;
  54 import org.opendaylight.openflowplugin.impl.util.DeviceInitializationUtils;
  55 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodesBuilder;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
  60 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  61 import org.slf4j.Logger;
  62 import org.slf4j.LoggerFactory;
  63
  64 /**
  65  *
  66  */
  67 public class DeviceManagerImpl implements DeviceManager, ExtensionConverterProviderKeeper {
  68
  69     private static final Logger LOG = LoggerFactory.getLogger(DeviceManagerImpl.class);
  70
  71     private final long globalNotificationQuota;
  72     private final boolean switchFeaturesMandatory;
  73     private boolean isNotificationFlowRemovedOff;
  74
  75     private static final int SPY_RATE = 10;
  76
  77     private final DataBroker dataBroker;
  78     private final ConvertorExecutor convertorExecutor;
  79     private TranslatorLibrary translatorLibrary;
  80     private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
  81     private DeviceTerminationPhaseHandler deviceTerminPhaseHandler;
  82
  83     private final ConcurrentMap<DeviceInfo, DeviceContext> deviceContexts = new ConcurrentHashMap<>();
  84
  85     private final long barrierIntervalNanos;
  86     private final int barrierCountLimit;
  87     private ExtensionConverterProvider extensionConverterProvider;
  88     private ScheduledThreadPoolExecutor spyPool;
  89     private Set<DeviceSynchronizeListener> deviceSynchronizedListeners;
  90     private Set<DeviceValidListener> deviceValidListeners;
  91
  92     private final LifecycleConductor conductor;
  93
  94     public DeviceManagerImpl(@Nonnull final DataBroker dataBroker,
  95                              final long globalNotificationQuota, final boolean switchFeaturesMandatory,
  96                              final long barrierInterval, final int barrierCountLimit,
  97                              final LifecycleConductor lifecycleConductor, boolean isNotificationFlowRemovedOff,
  98                              final ConvertorExecutor convertorExecutor) {
  99         this.switchFeaturesMandatory = switchFeaturesMandatory;
 100         this.globalNotificationQuota = globalNotificationQuota;
 101         this.isNotificationFlowRemovedOff = isNotificationFlowRemovedOff;
 102         this.dataBroker = Preconditions.checkNotNull(dataBroker);
 103         this.convertorExecutor = convertorExecutor;
 104         /* merge empty nodes to oper DS to predict any problems with missing parent for Node */
 105         final WriteTransaction tx = dataBroker.newWriteOnlyTransaction();
 106
 107         final NodesBuilder nodesBuilder = new NodesBuilder();
 108         nodesBuilder.setNode(Collections.<Node>emptyList());
 109         tx.merge(LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.create(Nodes.class), nodesBuilder.build());
 110         try {
 111             tx.submit().get();
 112         } catch (ExecutionException | InterruptedException e) {
 113             LOG.error("Creation of node failed.", e);
 114             throw new IllegalStateException(e);
 115         }
 116
 117         this.barrierIntervalNanos = TimeUnit.MILLISECONDS.toNanos(barrierInterval);
 118         this.barrierCountLimit = barrierCountLimit;
 119
 120         this.conductor = lifecycleConductor;
 121         spyPool = new ScheduledThreadPoolExecutor(1);
 122         this.deviceSynchronizedListeners = new HashSet<>();
 123         this.deviceValidListeners = new HashSet<>();
 124     }
 125
 126
 127     @Override
 128     public void setDeviceInitializationPhaseHandler(final DeviceInitializationPhaseHandler handler) {
 129         this.deviceInitPhaseHandler = handler;
 130     }
 131
 132     @Override
 133     public void onDeviceContextLevelUp(@CheckForNull DeviceInfo deviceInfo) throws Exception {
 134         // final phase - we have to add new Device to MD-SAL DataStore
 135         LOG.debug("Final phase of DeviceContextLevelUp for Node: {} ", deviceInfo.getNodeId());
 136         DeviceContext deviceContext = Preconditions.checkNotNull(deviceContexts.get(deviceInfo));
 137         ((DeviceContextImpl) deviceContext).initialSubmitTransaction();
 138         deviceContext.onPublished();
 139     }
 140
 141     @Override
 142     public boolean deviceConnected(@CheckForNull final ConnectionContext connectionContext) throws Exception {
 143         Preconditions.checkArgument(connectionContext != null);
 144
 145         DeviceInfo deviceInfo = connectionContext.getDeviceInfo();
 146         /**
 147          * This part prevent destroy another device context. Throwing here an exception result to propagate close connection
 148          * in {@link org.opendaylight.openflowplugin.impl.connection.org.opendaylight.openflowplugin.impl.connection.HandshakeContextImpl}
 149          * If context already exist we are in state closing process (connection flapping) and we should not propagate connection close
 150          */
 151          if (deviceContexts.containsKey(deviceInfo)) {
 152             LOG.warn("Rejecting connection from node which is already connected and there exist deviceContext for it: {}", connectionContext.getNodeId());
 153              return false;
 154          }
 155
 156         LOG.info("ConnectionEvent: Device connected to controller, Device:{}, NodeId:{}",
 157                 connectionContext.getConnectionAdapter().getRemoteAddress(), deviceInfo.getNodeId());
 158
 159         // Add Disconnect handler
 160         connectionContext.setDeviceDisconnectedHandler(DeviceManagerImpl.this);
 161         // Cache this for clarity
 162         final ConnectionAdapter connectionAdapter = connectionContext.getConnectionAdapter();
 163
 164         //FIXME: as soon as auxiliary connection are fully supported then this is needed only before device context published
 165         connectionAdapter.setPacketInFiltering(true);
 166
 167         final OutboundQueueProvider outboundQueueProvider = new OutboundQueueProviderImpl(deviceInfo.getVersion());
 168
 169         connectionContext.setOutboundQueueProvider(outboundQueueProvider);
 170         final OutboundQueueHandlerRegistration<OutboundQueueProvider> outboundQueueHandlerRegistration =
 171                 connectionAdapter.registerOutboundQueueHandler(outboundQueueProvider, barrierCountLimit, barrierIntervalNanos);
 172         connectionContext.setOutboundQueueHandleRegistration(outboundQueueHandlerRegistration);
 173
 174         final DeviceState deviceState = new DeviceStateImpl(deviceInfo);
 175         this.addDeviceSynchronizeListener(deviceState);
 176         this.addDeviceValidListener(deviceState);
 177
 178         final DeviceContext deviceContext = new DeviceContextImpl(connectionContext,
 179                 deviceState,
 180                 dataBroker,
 181                 conductor,
 182                 outboundQueueProvider,
 183                 translatorLibrary,
 184                 this);
 185
 186         Verify.verify(deviceContexts.putIfAbsent(deviceInfo, deviceContext) == null, "DeviceCtx still not closed.");
 187
 188         ((ExtensionConverterProviderKeeper) deviceContext).setExtensionConverterProvider(extensionConverterProvider);
 189         deviceContext.setNotificationPublishService(conductor.getNotificationPublishService());
 190
 191         updatePacketInRateLimiters();
 192
 193         final OpenflowProtocolListenerFullImpl messageListener = new OpenflowProtocolListenerFullImpl(
 194                 connectionAdapter, deviceContext);
 195         connectionAdapter.setMessageListener(messageListener);
 196         notifyDeviceValidListeners(deviceInfo, true);
 197
 198         deviceInitPhaseHandler.onDeviceContextLevelUp(connectionContext.getDeviceInfo());
 199
 200         notifyDeviceSynchronizeListeners(deviceInfo, true);
 201
 202         return true;
 203     }
 204
 205     private void updatePacketInRateLimiters() {
 206         synchronized (deviceContexts) {
 207             final int deviceContextsSize = deviceContexts.size();
 208             if (deviceContextsSize > 0) {
 209                 long freshNotificationLimit = globalNotificationQuota / deviceContextsSize;
 210                 if (freshNotificationLimit < 100) {
 211                     freshNotificationLimit = 100;
 212                 }
 213                 LOG.debug("fresh notification limit = {}", freshNotificationLimit);
 214                 for (final DeviceContext deviceContext : deviceContexts.values()) {
 215                     deviceContext.updatePacketInRateLimit(freshNotificationLimit);
 216                 }
 217             }
 218         }
 219     }
 220
 221     @Override
 222     public TranslatorLibrary oook() {
 223         return translatorLibrary;
 224     }
 225
 226     @Override
 227     public void setTranslatorLibrary(final TranslatorLibrary translatorLibrary) {
 228         this.translatorLibrary = translatorLibrary;
 229     }
 230
 231     @Override
 232     public void close() {
 233         for (final Iterator<DeviceContext> iterator = Iterators.consumingIterator(deviceContexts.values().iterator());
 234                 iterator.hasNext();) {
 235             final DeviceContext deviceCtx = iterator.next();
 236             notifyDeviceValidListeners(deviceCtx.getDeviceInfo(), false);
 237             deviceCtx.shutdownConnection();
 238             deviceCtx.shuttingDownDataStoreTransactions();
 239         }
 240
 241         if (spyPool != null) {
 242             spyPool.shutdownNow();
 243             spyPool = null;
 244         }
 245     }
 246
 247     @Override
 248     public void onDeviceContextLevelDown(final DeviceInfo deviceInfo) {
 249         LOG.debug("onDeviceContextClosed for Node {}", deviceInfo.getNodeId());
 250         deviceContexts.remove(deviceInfo);
 251         updatePacketInRateLimiters();
 252     }
 253
 254     @Override
 255     public void initialize() {
 256         spyPool.scheduleAtFixedRate(conductor.getMessageIntelligenceAgency(), SPY_RATE, SPY_RATE, TimeUnit.SECONDS);
 257     }
 258
 259     @Override
 260     public void setExtensionConverterProvider(final ExtensionConverterProvider extensionConverterProvider) {
 261         this.extensionConverterProvider = extensionConverterProvider;
 262     }
 263
 264     @Override
 265     public ExtensionConverterProvider getExtensionConverterProvider() {
 266         return extensionConverterProvider;
 267     }
 268
 269     @Override
 270     public void setDeviceTerminationPhaseHandler(final DeviceTerminationPhaseHandler handler) {
 271         this.deviceTerminPhaseHandler = handler;
 272     }
 273
 274     @Override
 275     public void onDeviceDisconnected(final ConnectionContext connectionContext) {
 276         LOG.trace("onDeviceDisconnected method call for Node: {}", connectionContext.getNodeId());
 277         final DeviceInfo deviceInfo = connectionContext.getDeviceInfo();
 278         final DeviceContext deviceCtx = this.deviceContexts.get(deviceInfo);
 279
 280         if (null == deviceCtx) {
 281             LOG.info("DeviceContext for Node {} was not found. Connection is terminated without OFP context suite.", deviceInfo.getNodeId());
 282             return;
 283         }
 284
 285         if (!connectionContext.equals(deviceCtx.getPrimaryConnectionContext())) {
 286             /* Connection is not PrimaryConnection so try to remove from Auxiliary Connections */
 287             deviceCtx.removeAuxiliaryConnectionContext(connectionContext);
 288         } else {
 289             notifyDeviceValidListeners(deviceInfo, false);
 290             /* Device is disconnected and so we need to close TxManager */
 291             final ListenableFuture<Void> future = deviceCtx.shuttingDownDataStoreTransactions();
 292             Futures.addCallback(future, new FutureCallback<Void>() {
 293
 294                 @Override
 295                 public void onSuccess(final Void result) {
 296                     LOG.debug("TxChainManager for device {} is closed successful.", deviceInfo.getNodeId());
 297                     deviceTerminPhaseHandler.onDeviceContextLevelDown(deviceInfo);
 298                 }
 299
 300                 @Override
 301                 public void onFailure(final Throwable t) {
 302                     LOG.warn("TxChainManager for device {} failed by closing.", deviceInfo.getNodeId(), t);
 303                     deviceTerminPhaseHandler.onDeviceContextLevelDown(deviceInfo);
 304                 }
 305             });
 306             /* Add timer for Close TxManager because it could fain ind cluster without notification */
 307             final TimerTask timerTask = timeout -> {
 308                 if (!future.isDone()) {
 309                     LOG.info("Shutting down TxChain for node {} not completed during 10 sec. Continue anyway.", deviceInfo.getNodeId());
 310                     future.cancel(false);
 311                 }
 312             };
 313             conductor.newTimeout(timerTask, 10, TimeUnit.SECONDS);
 314         }
 315     }
 316
 317     @VisibleForTesting
 318     void addDeviceContextToMap(final DeviceInfo deviceInfo, final DeviceContext deviceContext){
 319         deviceContexts.put(deviceInfo, deviceContext);
 320     }
 321
 322     @Override
 323     public <T extends OFPContext> T gainContext(final DeviceInfo deviceInfo) {
 324         return (T) deviceContexts.get(deviceInfo);
 325     }
 326
 327     @Override
 328     public ListenableFuture<Void> onClusterRoleChange(final DeviceInfo deviceInfo, final OfpRole role) {
 329         DeviceContext deviceContext = conductor.getDeviceContext(deviceInfo);
 330         LOG.trace("onClusterRoleChange {} for node:", role, deviceInfo.getNodeId());
 331         if (OfpRole.BECOMEMASTER.equals(role)) {
 332             return onDeviceTakeClusterLeadership(deviceInfo);
 333         }
 334         return ((DeviceContextImpl)deviceContext).getTransactionChainManager().deactivateTransactionManager();
 335     }
 336
 337     @Override
 338     public void addDeviceSynchronizeListener(final DeviceSynchronizeListener deviceSynchronizeListener) {
 339         this.deviceSynchronizedListeners.add(deviceSynchronizeListener);
 340     }
 341
 342     @Override
 343     public void notifyDeviceSynchronizeListeners(final DeviceInfo deviceInfo, final boolean deviceSynchronized) {
 344         for (DeviceSynchronizeListener listener : deviceSynchronizedListeners) {
 345             listener.deviceIsSynchronized(deviceInfo, deviceSynchronized);
 346         }
 347     }
 348
 349     @Override
 350     public void addDeviceValidListener(final DeviceValidListener deviceValidListener) {
 351         this.deviceValidListeners.add(deviceValidListener);
 352     }
 353
 354     @Override
 355     public void notifyDeviceValidListeners(final DeviceInfo deviceInfo, final boolean deviceValid) {
 356         for (DeviceValidListener listener : deviceValidListeners) {
 357             listener.deviceIsValid(deviceInfo, deviceValid);
 358         }
 359     }
 360
 361     @Override
 362     public void setIsNotificationFlowRemovedOff(boolean isNotificationFlowRemovedOff) {
 363         this.isNotificationFlowRemovedOff = isNotificationFlowRemovedOff;
 364     }
 365
 366     @Override
 367     public boolean getIsNotificationFlowRemovedOff() {
 368         return this.isNotificationFlowRemovedOff;
 369     }
 370
 371     private ListenableFuture<Void> onDeviceTakeClusterLeadership(final DeviceInfo deviceInfo) {
 372         LOG.trace("onDeviceTakeClusterLeadership for node: {}", deviceInfo.getNodeId());
 373         /* validation */
 374         StatisticsContext statisticsContext = conductor.getStatisticsContext(deviceInfo);
 375         if (statisticsContext == null) {
 376             final String errMsg = String.format("DeviceCtx %s is up but we are missing StatisticsContext", deviceInfo.getDatapathId());
 377             LOG.warn(errMsg);
 378             return Futures.immediateFailedFuture(new IllegalStateException(errMsg));
 379         }
 380         DeviceContext deviceContext = conductor.getDeviceContext(deviceInfo);
 381         /* Prepare init info collecting */
 382         notifyDeviceSynchronizeListeners(deviceInfo, false);
 383         ((DeviceContextImpl)deviceContext).getTransactionChainManager().activateTransactionManager();
 384         /* Init Collecting NodeInfo */
 385         final ListenableFuture<Void> initCollectingDeviceInfo = DeviceInitializationUtils.initializeNodeInformation(
 386                 deviceContext, switchFeaturesMandatory, convertorExecutor);
 387         /* Init Collecting StatInfo */
 388         final ListenableFuture<Boolean> statPollFuture = Futures.transform(initCollectingDeviceInfo,
 389                 new AsyncFunction<Void, Boolean>() {
 390
 391                     @Override
 392                     public ListenableFuture<Boolean> apply(@Nonnull final Void input) throws Exception {
 393                         statisticsContext.statListForCollectingInitialization();
 394                         return statisticsContext.initialGatherDynamicData();
 395                     }
 396                 });
 397
 398         return Futures.transform(statPollFuture, getInitialDeviceInformation(deviceContext));
 399     }
 400
 401     private Function<Boolean, Void> getInitialDeviceInformation(final DeviceContext deviceContext) {
 402         return input -> {
 403             if (ConnectionContext.CONNECTION_STATE.RIP.equals(
 404                     conductor.gainConnectionStateSafely(deviceContext.getDeviceInfo())
 405             )) {
 406                 final String errMsg =
 407                         String.format("We lost connection for Device %s, context has to be closed.",
 408                         deviceContext.getDeviceInfo().getNodeId());
 409                 LOG.warn(errMsg);
 410                 throw new IllegalStateException(errMsg);
 411             }
 412
 413             if (input == null || !input) {
 414                 final String errMsg =
 415                         String.format("Get Initial Device %s information fails",
 416                         deviceContext.getDeviceInfo().getNodeId());
 417                 LOG.warn(errMsg);
 418                 throw new IllegalStateException(errMsg);
 419             }
 420             LOG.debug("Get Initial Device {} information is successful",
 421                     deviceContext.getDeviceInfo().getNodeId());
 422             notifyDeviceSynchronizeListeners(deviceContext.getDeviceInfo(), true);
 423             ((DeviceContextImpl)deviceContext).getTransactionChainManager().initialSubmitWriteTransaction();
 424             deviceContext.getDeviceState().setStatisticsPollingEnabledProp(true);
 425             return null;
 426         };
 427     }
 428
 429 }