openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/OpenFlowPluginProviderImpl.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;
   9
  10 import com.google.common.annotations.VisibleForTesting;
  11 import com.google.common.util.concurrent.FutureCallback;
  12 import com.google.common.util.concurrent.Futures;
  13 import com.google.common.util.concurrent.ListenableFuture;
  14 import com.google.common.util.concurrent.ListeningExecutorService;
  15 import com.google.common.util.concurrent.MoreExecutors;
  16 import com.google.common.util.concurrent.SettableFuture;
  17 import io.netty.util.HashedWheelTimer;
  18 import io.netty.util.Timer;
  19 import java.lang.management.ManagementFactory;
  20 import java.util.Collection;
  21 import java.util.List;
  22 import java.util.concurrent.ExecutionException;
  23 import java.util.concurrent.ExecutorService;
  24 import java.util.concurrent.Future;
  25 import java.util.concurrent.SynchronousQueue;
  26 import java.util.concurrent.TimeUnit;
  27 import java.util.concurrent.TimeoutException;
  28 import java.util.stream.Collectors;
  29 import javax.annotation.Nonnull;
  30 import javax.annotation.PostConstruct;
  31 import javax.annotation.PreDestroy;
  32 import javax.inject.Inject;
  33 import javax.inject.Singleton;
  34 import javax.management.InstanceAlreadyExistsException;
  35 import javax.management.InstanceNotFoundException;
  36 import javax.management.MBeanRegistrationException;
  37 import javax.management.MBeanServer;
  38 import javax.management.MalformedObjectNameException;
  39 import javax.management.NotCompliantMBeanException;
  40 import javax.management.ObjectName;
  41 import org.apache.aries.blueprint.annotation.service.Reference;
  42 import org.apache.aries.blueprint.annotation.service.Service;
  43 import org.opendaylight.infrautils.diagstatus.ServiceState;
  44 import org.opendaylight.infrautils.ready.SystemReadyListener;
  45 import org.opendaylight.infrautils.ready.SystemReadyMonitor;
  46 import org.opendaylight.mdsal.binding.api.DataBroker;
  47 import org.opendaylight.mdsal.binding.api.NotificationPublishService;
  48 import org.opendaylight.mdsal.binding.api.RpcProviderService;
  49 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipService;
  50 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  51 import org.opendaylight.openflowjava.protocol.api.connection.OpenflowDiagStatusProvider;
  52 import org.opendaylight.openflowjava.protocol.spi.connection.SwitchConnectionProvider;
  53 import org.opendaylight.openflowjava.protocol.spi.connection.SwitchConnectionProviderList;
  54 import org.opendaylight.openflowplugin.api.openflow.OpenFlowPluginProvider;
  55 import org.opendaylight.openflowplugin.api.openflow.configuration.ConfigurationService;
  56 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionManager;
  57 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
  58 import org.opendaylight.openflowplugin.api.openflow.mastership.MastershipChangeServiceManager;
  59 import org.opendaylight.openflowplugin.api.openflow.role.RoleManager;
  60 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcManager;
  61 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsManager;
  62 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageIntelligenceAgency;
  63 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterProviderKeeper;
  64 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterRegistrator;
  65 import org.opendaylight.openflowplugin.extension.api.OpenFlowPluginExtensionRegistratorProvider;
  66 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterManager;
  67 import org.opendaylight.openflowplugin.impl.configuration.OpenFlowProviderConfigImpl;
  68 import org.opendaylight.openflowplugin.impl.connection.ConnectionManagerImpl;
  69 import org.opendaylight.openflowplugin.impl.device.DeviceManagerImpl;
  70 import org.opendaylight.openflowplugin.impl.device.initialization.DeviceInitializerProvider;
  71 import org.opendaylight.openflowplugin.impl.device.initialization.DeviceInitializerProviderFactory;
  72 import org.opendaylight.openflowplugin.impl.lifecycle.ContextChainHolderImpl;
  73 import org.opendaylight.openflowplugin.impl.protocol.deserialization.DeserializerInjector;
  74 import org.opendaylight.openflowplugin.impl.protocol.serialization.SerializerInjector;
  75 import org.opendaylight.openflowplugin.impl.role.RoleManagerImpl;
  76 import org.opendaylight.openflowplugin.impl.rpc.RpcManagerImpl;
  77 import org.opendaylight.openflowplugin.impl.statistics.StatisticsManagerImpl;
  78 import org.opendaylight.openflowplugin.impl.statistics.ofpspecific.MessageIntelligenceAgencyImpl;
  79 import org.opendaylight.openflowplugin.impl.statistics.ofpspecific.MessageIntelligenceAgencyMXBean;
  80 import org.opendaylight.openflowplugin.impl.util.ThreadPoolLoggingExecutor;
  81 import org.opendaylight.openflowplugin.impl.util.TranslatorLibraryUtil;
  82 import org.opendaylight.openflowplugin.openflow.md.core.extension.ExtensionConverterManagerImpl;
  83 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManager;
  84 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManagerFactory;
  85 import org.opendaylight.openflowplugin.openflow.md.core.session.OFSessionUtil;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.OpenflowProviderConfig;
  87 import org.slf4j.Logger;
  88 import org.slf4j.LoggerFactory;
  89
  90 @Singleton
  91 @Service(classes = { OpenFlowPluginProvider.class, OpenFlowPluginExtensionRegistratorProvider.class })
  92 public class OpenFlowPluginProviderImpl implements
  93         OpenFlowPluginProvider,
  94         OpenFlowPluginExtensionRegistratorProvider,
  95         SystemReadyListener {
  96
  97     private static final Logger LOG = LoggerFactory.getLogger(OpenFlowPluginProviderImpl.class);
  98
  99     private static final int TICKS_PER_WHEEL = 500; // 0.5 sec.
 100     private static final long TICK_DURATION = 10;
 101     private static final String POOL_NAME = "ofppool";
 102
 103     private static final MessageIntelligenceAgency MESSAGE_INTELLIGENCE_AGENCY = new MessageIntelligenceAgencyImpl();
 104     private static final String MESSAGE_INTELLIGENCE_AGENCY_MX_BEAN_NAME = String
 105             .format("%s:type=%s",
 106                     MessageIntelligenceAgencyMXBean.class.getPackage().getName(),
 107                     MessageIntelligenceAgencyMXBean.class.getSimpleName());
 108
 109     private final HashedWheelTimer hashedWheelTimer =
 110             new HashedWheelTimer(TICK_DURATION, TimeUnit.MILLISECONDS, TICKS_PER_WHEEL);
 111     private final NotificationPublishService notificationPublishService;
 112     private final ExtensionConverterManager extensionConverterManager;
 113     private final DataBroker dataBroker;
 114     private final Collection<SwitchConnectionProvider> switchConnectionProviders;
 115     private final DeviceInitializerProvider deviceInitializerProvider;
 116     private final ConvertorManager convertorManager;
 117     private final RpcProviderService rpcProviderRegistry;
 118     private final ClusterSingletonServiceProvider singletonServicesProvider;
 119     private final OpenflowProviderConfig config;
 120     private final EntityOwnershipService entityOwnershipService;
 121     private final MastershipChangeServiceManager mastershipChangeServiceManager;
 122     private DeviceManager deviceManager;
 123     private RpcManager rpcManager;
 124     private StatisticsManager statisticsManager;
 125     private RoleManager roleManager;
 126     private ConnectionManager connectionManager;
 127     private ListeningExecutorService executorService;
 128     private ContextChainHolderImpl contextChainHolder;
 129     private final OpenflowDiagStatusProvider openflowDiagStatusProvider;
 130     private final SettableFuture<Void> fullyStarted = SettableFuture.create();
 131     private static final String OPENFLOW_SERVICE_NAME = "OPENFLOW";
 132
 133     public static MessageIntelligenceAgency getMessageIntelligenceAgency() {
 134         return MESSAGE_INTELLIGENCE_AGENCY;
 135     }
 136
 137     @Inject
 138     public OpenFlowPluginProviderImpl(final ConfigurationService configurationService,
 139                                final SwitchConnectionProviderList switchConnectionProviders,
 140                                final PingPongDataBroker pingPongDataBroker,
 141                                final @Reference RpcProviderService rpcProviderRegistry,
 142                                final @Reference NotificationPublishService notificationPublishService,
 143                                final @Reference ClusterSingletonServiceProvider singletonServiceProvider,
 144                                final @Reference EntityOwnershipService entityOwnershipService,
 145                                final MastershipChangeServiceManager mastershipChangeServiceManager,
 146                                final @Reference OpenflowDiagStatusProvider openflowDiagStatusProvider,
 147                                final @Reference SystemReadyMonitor systemReadyMonitor) {
 148         this.switchConnectionProviders = switchConnectionProviders;
 149         this.dataBroker = pingPongDataBroker;
 150         this.rpcProviderRegistry = rpcProviderRegistry;
 151         this.notificationPublishService = notificationPublishService;
 152         this.singletonServicesProvider = singletonServiceProvider;
 153         this.entityOwnershipService = entityOwnershipService;
 154         convertorManager = ConvertorManagerFactory.createDefaultManager();
 155         extensionConverterManager = new ExtensionConverterManagerImpl();
 156         deviceInitializerProvider = DeviceInitializerProviderFactory.createDefaultProvider();
 157         config = new OpenFlowProviderConfigImpl(configurationService);
 158         this.mastershipChangeServiceManager = mastershipChangeServiceManager;
 159         this.openflowDiagStatusProvider = openflowDiagStatusProvider;
 160         systemReadyMonitor.registerListener(this);
 161         LOG.info("registered onSystemBootReady() listener for deferred startSwitchConnections()");
 162     }
 163
 164     @Override
 165     public void onSystemBootReady() {
 166         LOG.info("onSystemBootReady() received, starting the switch connections");
 167         Futures.addCallback(Futures.allAsList(switchConnectionProviders.stream().map(switchConnectionProvider -> {
 168             // Inject OpenFlowPlugin custom serializers and deserializers into OpenFlowJava
 169             if (config.isUseSingleLayerSerialization()) {
 170                 SerializerInjector.injectSerializers(switchConnectionProvider,
 171                         switchConnectionProvider.getConfiguration().isGroupAddModEnabled());
 172                 DeserializerInjector.injectDeserializers(switchConnectionProvider);
 173             } else {
 174                 DeserializerInjector.revertDeserializers(switchConnectionProvider);
 175             }
 176
 177             // Set handler of incoming connections and start switch connection provider
 178             switchConnectionProvider.setSwitchConnectionHandler(connectionManager);
 179             return switchConnectionProvider.startup();
 180         }).collect(Collectors.toSet())), new FutureCallback<List<Boolean>>() {
 181             @Override
 182             public void onSuccess(@Nonnull final List<Boolean> result) {
 183                 LOG.info("All switchConnectionProviders are up and running ({}).", result.size());
 184                 openflowDiagStatusProvider.reportStatus(OPENFLOW_SERVICE_NAME, ServiceState.OPERATIONAL);
 185                 fullyStarted.set(null);
 186             }
 187
 188             @Override
 189             public void onFailure(@Nonnull final Throwable throwable) {
 190                 LOG.warn("Some switchConnectionProviders failed to start.", throwable);
 191                 openflowDiagStatusProvider.reportStatus(OPENFLOW_SERVICE_NAME, throwable);
 192                 fullyStarted.setException(throwable);
 193             }
 194         }, MoreExecutors.directExecutor());
 195     }
 196
 197     @VisibleForTesting
 198     public Future<Void> getFullyStarted() {
 199         return fullyStarted;
 200     }
 201
 202     private ListenableFuture<List<Boolean>> shutdownSwitchConnections() {
 203         final ListenableFuture<List<Boolean>> listListenableFuture =
 204                 Futures.allAsList(switchConnectionProviders.stream().map(switchConnectionProvider -> {
 205                     // Revert deserializers to their original state
 206                     if (config.isUseSingleLayerSerialization()) {
 207                         DeserializerInjector.revertDeserializers(switchConnectionProvider);
 208                     }
 209
 210                     // Shutdown switch connection provider
 211                     return switchConnectionProvider.shutdown();
 212                 }).collect(Collectors.toSet()));
 213
 214         Futures.addCallback(listListenableFuture, new FutureCallback<List<Boolean>>() {
 215             @Override
 216             public void onSuccess(@Nonnull final List<Boolean> result) {
 217                 LOG.info("All switchConnectionProviders were successfully shut down ({}).", result.size());
 218             }
 219
 220             @Override
 221             public void onFailure(@Nonnull final Throwable throwable) {
 222                 LOG.warn("Some switchConnectionProviders failed to shutdown.", throwable);
 223             }
 224         }, MoreExecutors.directExecutor());
 225
 226         return listListenableFuture;
 227     }
 228
 229     @Override
 230     @PostConstruct
 231     public void initialize() {
 232         registerMXBean(MESSAGE_INTELLIGENCE_AGENCY, MESSAGE_INTELLIGENCE_AGENCY_MX_BEAN_NAME);
 233
 234         // TODO: copied from OpenFlowPluginProvider (Helium) misusesing the old way of distributing extension converters
 235         // TODO: rewrite later!
 236         OFSessionUtil.getSessionManager().setExtensionConverterProvider(extensionConverterManager);
 237
 238         // Creates a thread pool that creates new threads as needed, but will reuse previously
 239         // constructed threads when they are available.
 240         // Threads that have not been used for x seconds are terminated and removed from the cache.
 241         executorService = MoreExecutors.listeningDecorator(new ThreadPoolLoggingExecutor(
 242                 config.getThreadPoolMinThreads(),
 243                 config.getThreadPoolMaxThreads().getValue(),
 244                 config.getThreadPoolTimeout(),
 245                 TimeUnit.SECONDS, new SynchronousQueue<>(), POOL_NAME));
 246
 247         deviceManager = new DeviceManagerImpl(
 248                 config,
 249                 dataBroker,
 250                 getMessageIntelligenceAgency(),
 251                 notificationPublishService,
 252                 hashedWheelTimer,
 253                 convertorManager,
 254                 deviceInitializerProvider);
 255
 256         TranslatorLibraryUtil.injectBasicTranslatorLibrary(deviceManager, convertorManager);
 257         ((ExtensionConverterProviderKeeper) deviceManager).setExtensionConverterProvider(extensionConverterManager);
 258
 259         rpcManager = new RpcManagerImpl(
 260                 config,
 261                 rpcProviderRegistry,
 262                 extensionConverterManager,
 263                 convertorManager,
 264                 notificationPublishService);
 265
 266         statisticsManager = new StatisticsManagerImpl(
 267                 config,
 268                 rpcProviderRegistry,
 269                 convertorManager,
 270                 executorService);
 271
 272         roleManager = new RoleManagerImpl(hashedWheelTimer, config);
 273
 274         contextChainHolder = new ContextChainHolderImpl(
 275                 executorService,
 276                 singletonServicesProvider,
 277                 entityOwnershipService,
 278                 mastershipChangeServiceManager);
 279
 280         contextChainHolder.addManager(deviceManager);
 281         contextChainHolder.addManager(statisticsManager);
 282         contextChainHolder.addManager(rpcManager);
 283         contextChainHolder.addManager(roleManager);
 284
 285         connectionManager = new ConnectionManagerImpl(config, executorService);
 286         connectionManager.setDeviceConnectedHandler(contextChainHolder);
 287         connectionManager.setDeviceDisconnectedHandler(contextChainHolder);
 288
 289         deviceManager.setContextChainHolder(contextChainHolder);
 290         deviceManager.initialize();
 291     }
 292
 293     @Override
 294     public ExtensionConverterRegistrator getExtensionConverterRegistrator() {
 295         return extensionConverterManager;
 296     }
 297
 298     @Override
 299     @PreDestroy
 300     public void close() {
 301         try {
 302             shutdownSwitchConnections().get(10, TimeUnit.SECONDS);
 303         } catch (InterruptedException | ExecutionException | TimeoutException e) {
 304             LOG.warn("Failed to shut down switch connections in time {}s", 10, e);
 305         }
 306
 307         gracefulShutdown(contextChainHolder);
 308         gracefulShutdown(deviceManager);
 309         gracefulShutdown(rpcManager);
 310         gracefulShutdown(statisticsManager);
 311         gracefulShutdown(roleManager);
 312         gracefulShutdown(executorService);
 313         gracefulShutdown(hashedWheelTimer);
 314         unregisterMXBean(MESSAGE_INTELLIGENCE_AGENCY_MX_BEAN_NAME);
 315         openflowDiagStatusProvider.reportStatus(ServiceState.UNREGISTERED);
 316     }
 317
 318     @SuppressWarnings("checkstyle:IllegalCatch")
 319     private static void gracefulShutdown(final AutoCloseable closeable) {
 320         if (closeable != null) {
 321             try {
 322                 closeable.close();
 323             } catch (Exception e) {
 324                 LOG.warn("Failed to shutdown {} gracefully.", closeable);
 325             }
 326         }
 327     }
 328
 329     private static void gracefulShutdown(final Timer timer) {
 330         if (timer != null) {
 331             try {
 332                 timer.stop();
 333             } catch (IllegalStateException e) {
 334                 LOG.warn("Failed to shutdown {} gracefully.", timer);
 335             }
 336         }
 337     }
 338
 339     private static void gracefulShutdown(final ExecutorService executorService) {
 340         if (executorService != null) {
 341             try {
 342                 executorService.shutdownNow();
 343             } catch (SecurityException e) {
 344                 LOG.warn("Failed to shutdown {} gracefully.", executorService);
 345             }
 346         }
 347     }
 348
 349     private static void registerMXBean(final Object bean, final String beanName) {
 350         final MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
 351
 352         try {
 353             mbs.registerMBean(bean, new ObjectName(beanName));
 354         } catch (MalformedObjectNameException
 355                 | NotCompliantMBeanException
 356                 | MBeanRegistrationException
 357                 | InstanceAlreadyExistsException e) {
 358             LOG.warn("Error registering MBean {}", e);
 359         }
 360     }
 361
 362     private static void unregisterMXBean(final String beanName) {
 363         final MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
 364
 365         try {
 366             mbs.unregisterMBean(new ObjectName(beanName));
 367         } catch (InstanceNotFoundException
 368                 | MBeanRegistrationException
 369                 | MalformedObjectNameException e) {
 370             LOG.warn("Error unregistering MBean {}", e);
 371         }
 372     }
 373 }