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