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