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
   9 package org.opendaylight.openflowplugin.impl;
  10
  11
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.util.concurrent.FutureCallback;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import io.netty.util.HashedWheelTimer;
  17 import java.lang.management.ManagementFactory;
  18 import java.util.ArrayList;
  19 import java.util.Collection;
  20 import java.util.List;
  21 import java.util.Map;
  22 import java.util.concurrent.SynchronousQueue;
  23 import java.util.concurrent.ThreadPoolExecutor;
  24 import java.util.concurrent.TimeUnit;
  25 import javax.annotation.Nonnull;
  26 import javax.management.InstanceAlreadyExistsException;
  27 import javax.management.MBeanRegistrationException;
  28 import javax.management.MBeanServer;
  29 import javax.management.MalformedObjectNameException;
  30 import javax.management.NotCompliantMBeanException;
  31 import javax.management.ObjectName;
  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.NotificationService;
  35 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  36 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  37 import org.opendaylight.openflowjava.protocol.spi.connection.SwitchConnectionProvider;
  38 import org.opendaylight.openflowplugin.api.openflow.OpenFlowPluginProvider;
  39 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionManager;
  40 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
  41 import org.opendaylight.openflowplugin.api.openflow.role.RoleManager;
  42 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcManager;
  43 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsManager;
  44 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageIntelligenceAgency;
  45 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterProviderKeeper;
  46 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterRegistrator;
  47 import org.opendaylight.openflowplugin.extension.api.OpenFlowPluginExtensionRegistratorProvider;
  48 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterManager;
  49 import org.opendaylight.openflowplugin.impl.connection.ConnectionManagerImpl;
  50 import org.opendaylight.openflowplugin.impl.device.DeviceManagerImpl;
  51 import org.opendaylight.openflowplugin.impl.role.RoleManagerImpl;
  52 import org.opendaylight.openflowplugin.impl.rpc.RpcManagerImpl;
  53 import org.opendaylight.openflowplugin.impl.statistics.StatisticsManagerImpl;
  54 import org.opendaylight.openflowplugin.impl.statistics.ofpspecific.MessageIntelligenceAgencyImpl;
  55 import org.opendaylight.openflowplugin.impl.statistics.ofpspecific.MessageIntelligenceAgencyMXBean;
  56 import org.opendaylight.openflowplugin.impl.util.TranslatorLibraryUtil;
  57 import org.opendaylight.openflowplugin.openflow.md.core.ThreadPoolLoggingExecutor;
  58 import org.opendaylight.openflowplugin.openflow.md.core.extension.ExtensionConverterManagerImpl;
  59 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManager;
  60 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManagerFactory;
  61 import org.opendaylight.openflowplugin.openflow.md.core.session.OFSessionUtil;
  62 import org.slf4j.Logger;
  63 import org.slf4j.LoggerFactory;
  64
  65 public class OpenFlowPluginProviderImpl implements OpenFlowPluginProvider, OpenFlowPluginExtensionRegistratorProvider {
  66
  67     private static final Logger LOG = LoggerFactory.getLogger(OpenFlowPluginProviderImpl.class);
  68     private static final MessageIntelligenceAgency messageIntelligenceAgency = new MessageIntelligenceAgencyImpl();
  69     private static final int TICKS_PER_WHEEL = 500;
  70     private static final long TICK_DURATION = 10; // 0.5 sec.
  71
  72     private final HashedWheelTimer hashedWheelTimer = new HashedWheelTimer(TICK_DURATION, TimeUnit.MILLISECONDS, TICKS_PER_WHEEL);
  73
  74     private final int rpcRequestsQuota;
  75     private final long globalNotificationQuota;
  76     private final ConvertorManager convertorManager;
  77     private long barrierInterval;
  78     private int barrierCountLimit;
  79     private long echoReplyTimeout;
  80     private DeviceManager deviceManager;
  81     private RoleManager roleManager;
  82     private RpcManager rpcManager;
  83     private RpcProviderRegistry rpcProviderRegistry;
  84     private StatisticsManager statisticsManager;
  85     private ConnectionManager connectionManager;
  86     private NotificationService notificationProviderService;
  87     private NotificationPublishService notificationPublishService;
  88     private ExtensionConverterManager extensionConverterManager;
  89     private DataBroker dataBroker;
  90     private Collection<SwitchConnectionProvider> switchConnectionProviders;
  91     private boolean switchFeaturesMandatory = false;
  92     private boolean isStatisticsPollingOff = false;
  93     private boolean isStatisticsRpcEnabled;
  94     private boolean isNotificationFlowRemovedOff = false;
  95     private final ThreadPoolExecutor threadPool;
  96     private ClusterSingletonServiceProvider singletonServicesProvider;
  97
  98     public OpenFlowPluginProviderImpl(final long rpcRequestsQuota,
  99                                       final long globalNotificationQuota,
 100                                       final int threadPoolMinThreads,
 101                                       final int threadPoolMaxThreads,
 102                                       final long threadPoolTimeout) {
 103         Preconditions.checkArgument(rpcRequestsQuota > 0 && rpcRequestsQuota <= Integer.MAX_VALUE, "rpcRequestQuota has to be in range <1,%s>", Integer.MAX_VALUE);
 104         this.rpcRequestsQuota = (int) rpcRequestsQuota;
 105         this.globalNotificationQuota = Preconditions.checkNotNull(globalNotificationQuota);
 106
 107         // Creates a thread pool that creates new threads as needed, but will reuse previously
 108         // constructed threads when they are available.
 109         // Threads that have not been used for x seconds are terminated and removed from the cache.
 110         threadPool = new ThreadPoolLoggingExecutor(
 111                 Preconditions.checkNotNull(threadPoolMinThreads),
 112                 Preconditions.checkNotNull(threadPoolMaxThreads),
 113                 Preconditions.checkNotNull(threadPoolTimeout), TimeUnit.SECONDS,
 114                 new SynchronousQueue<>(), "ofppool");
 115         convertorManager = ConvertorManagerFactory.createDefaultManager();
 116     }
 117
 118     @Override
 119     public boolean isStatisticsPollingOff() {
 120         return isStatisticsPollingOff;
 121     }
 122
 123     @Override
 124     public void setIsStatisticsPollingOff(final boolean isStatisticsPollingOff) {
 125         this.isStatisticsPollingOff = isStatisticsPollingOff;
 126     }
 127
 128     private void startSwitchConnections() {
 129         final List<ListenableFuture<Boolean>> starterChain = new ArrayList<>(switchConnectionProviders.size());
 130         for (final SwitchConnectionProvider switchConnectionPrv : switchConnectionProviders) {
 131             switchConnectionPrv.setSwitchConnectionHandler(connectionManager);
 132             final ListenableFuture<Boolean> isOnlineFuture = switchConnectionPrv.startup();
 133             starterChain.add(isOnlineFuture);
 134         }
 135
 136         final ListenableFuture<List<Boolean>> srvStarted = Futures.allAsList(starterChain);
 137         Futures.addCallback(srvStarted, new FutureCallback<List<Boolean>>() {
 138             @Override
 139             public void onSuccess(final List<Boolean> result) {
 140                 LOG.info("All switchConnectionProviders are up and running ({}).",
 141                         result.size());
 142             }
 143
 144             @Override
 145             public void onFailure(@Nonnull final Throwable t) {
 146                 LOG.warn("Some switchConnectionProviders failed to start.", t);
 147             }
 148         });
 149     }
 150
 151     @Override
 152     public boolean isSwitchFeaturesMandatory() {
 153         return switchFeaturesMandatory;
 154     }
 155
 156     @Override
 157     public void setBarrierCountLimit(final int barrierCountLimit) {
 158         this.barrierCountLimit = barrierCountLimit;
 159     }
 160
 161     @Override
 162     public void setBarrierInterval(final long barrierTimeoutLimit) {
 163         this.barrierInterval = barrierTimeoutLimit;
 164     }
 165
 166     @Override
 167     public void setEchoReplyTimeout(final long echoReplyTimeout) {
 168         this.echoReplyTimeout = echoReplyTimeout;
 169     }
 170
 171     @Override
 172     public void setNotificationFlowRemovedOff(boolean isNotificationFlowRemovedOff) {
 173         this.isNotificationFlowRemovedOff = isNotificationFlowRemovedOff;
 174     }
 175
 176     public void setClusteringSingletonServicesProvider(ClusterSingletonServiceProvider singletonServicesProvider) {
 177         this.singletonServicesProvider = singletonServicesProvider;
 178     }
 179
 180     @Override
 181     public void setSwitchFeaturesMandatory(final boolean switchFeaturesMandatory) {
 182         this.switchFeaturesMandatory = switchFeaturesMandatory;
 183     }
 184
 185     public static MessageIntelligenceAgency getMessageIntelligenceAgency() {
 186         return OpenFlowPluginProviderImpl.messageIntelligenceAgency;
 187     }
 188
 189     @Override
 190     public void setSwitchConnectionProviders(final Collection<SwitchConnectionProvider> switchConnectionProviders) {
 191         this.switchConnectionProviders = switchConnectionProviders;
 192     }
 193
 194     @Override
 195     public void setDataBroker(final DataBroker dataBroker) {
 196         this.dataBroker = dataBroker;
 197     }
 198
 199     @Override
 200     public void setRpcProviderRegistry(final RpcProviderRegistry rpcProviderRegistry) {
 201         this.rpcProviderRegistry = rpcProviderRegistry;
 202     }
 203
 204     @Override
 205     public void initialize() {
 206         Preconditions.checkNotNull(dataBroker, "missing data broker");
 207         Preconditions.checkNotNull(rpcProviderRegistry, "missing RPC provider registry");
 208         Preconditions.checkNotNull(notificationProviderService, "missing notification provider service");
 209         Preconditions.checkNotNull(singletonServicesProvider, "missing singleton services provider");
 210
 211         extensionConverterManager = new ExtensionConverterManagerImpl();
 212         // TODO: copied from OpenFlowPluginProvider (Helium) misusesing the old way of distributing extension converters
 213         // TODO: rewrite later!
 214         OFSessionUtil.getSessionManager().setExtensionConverterProvider(extensionConverterManager);
 215
 216         connectionManager = new ConnectionManagerImpl(echoReplyTimeout, threadPool);
 217
 218         registerMXBean(messageIntelligenceAgency);
 219
 220         deviceManager = new DeviceManagerImpl(dataBroker,
 221                 globalNotificationQuota,
 222                 switchFeaturesMandatory,
 223                 barrierInterval,
 224                 barrierCountLimit,
 225                 getMessageIntelligenceAgency(),
 226                 isNotificationFlowRemovedOff,
 227
 228                 singletonServicesProvider,
 229                 notificationPublishService,
 230                 hashedWheelTimer,
 231                 convertorManager);
 232
 233         ((ExtensionConverterProviderKeeper) deviceManager).setExtensionConverterProvider(extensionConverterManager);
 234
 235         rpcManager = new RpcManagerImpl(rpcProviderRegistry, rpcRequestsQuota, extensionConverterManager, convertorManager, notificationPublishService);
 236         roleManager = new RoleManagerImpl(dataBroker, hashedWheelTimer);
 237         statisticsManager = new StatisticsManagerImpl(rpcProviderRegistry, isStatisticsPollingOff, hashedWheelTimer, convertorManager);
 238
 239         /* Initialization Phase ordering - OFP Device Context suite */
 240         // CM -> DM -> SM -> RPC -> Role -> DM
 241         connectionManager.setDeviceConnectedHandler(deviceManager);
 242         deviceManager.setDeviceInitializationPhaseHandler(statisticsManager);
 243         statisticsManager.setDeviceInitializationPhaseHandler(rpcManager);
 244         rpcManager.setDeviceInitializationPhaseHandler(roleManager);
 245         roleManager.setDeviceInitializationPhaseHandler(deviceManager);
 246
 247         /* Termination Phase ordering - OFP Device Context suite */
 248         deviceManager.setDeviceTerminationPhaseHandler(rpcManager);
 249         rpcManager.setDeviceTerminationPhaseHandler(statisticsManager);
 250         statisticsManager.setDeviceTerminationPhaseHandler(roleManager);
 251         roleManager.setDeviceTerminationPhaseHandler(deviceManager);
 252
 253         rpcManager.setStatisticsRpcEnabled(isStatisticsRpcEnabled);
 254
 255         TranslatorLibraryUtil.injectBasicTranslatorLibrary(deviceManager, convertorManager);
 256         deviceManager.initialize();
 257
 258         startSwitchConnections();
 259     }
 260
 261     @Override
 262     public void update(Map<String,Object> props) {
 263         LOG.debug("Update managed properties = {}", props.toString());
 264         if(deviceManager != null && props.containsKey("notification-flow-removed-off")) {
 265             deviceManager.setIsNotificationFlowRemovedOff(Boolean.valueOf(props.get("notification-flow-removed-off").toString()));
 266         }
 267     }
 268
 269     private static void registerMXBean(final MessageIntelligenceAgency messageIntelligenceAgency) {
 270         final MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
 271         try {
 272             final String pathToMxBean = String.format("%s:type=%s",
 273                     MessageIntelligenceAgencyMXBean.class.getPackage().getName(),
 274                     MessageIntelligenceAgencyMXBean.class.getSimpleName());
 275             final ObjectName name = new ObjectName(pathToMxBean);
 276             mbs.registerMBean(messageIntelligenceAgency, name);
 277         } catch (MalformedObjectNameException
 278                 | NotCompliantMBeanException
 279                 | MBeanRegistrationException
 280                 | InstanceAlreadyExistsException e) {
 281             LOG.warn("Error registering MBean {}", e);
 282         }
 283     }
 284
 285     @Override
 286     public void setNotificationProviderService(final NotificationService notificationProviderService) {
 287         this.notificationProviderService = notificationProviderService;
 288     }
 289
 290     @Override
 291     public void setNotificationPublishService(final NotificationPublishService notificationPublishProviderService) {
 292         this.notificationPublishService = notificationPublishProviderService;
 293     }
 294
 295     @Override
 296     public ExtensionConverterRegistrator getExtensionConverterRegistrator() {
 297         return extensionConverterManager;
 298     }
 299
 300     @Override
 301     public void setIsStatisticsRpcEnabled(final boolean isStatisticsRpcEnabled) {
 302         this.isStatisticsRpcEnabled = isStatisticsRpcEnabled;
 303     }
 304
 305     @Override
 306     public void close() throws Exception {
 307         //TODO: consider wrapping each manager into try-catch
 308         deviceManager.close();
 309         rpcManager.close();
 310         statisticsManager.close();
 311
 312         // TODO: needs to close org.opendaylight.openflowplugin.impl.role.OpenflowOwnershipListener after RoleContexts are down
 313         // TODO: must not be executed prior to all living RoleContexts have been closed (via closing living DeviceContexts)
 314         roleManager.close();
 315
 316         // Manually shutdown all remaining running threads in pool
 317         threadPool.shutdown();
 318     }
 319 }