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.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.rpc.RpcManager;
  42 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsManager;
  43 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageIntelligenceAgency;
  44 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterProviderKeeper;
  45 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterRegistrator;
  46 import org.opendaylight.openflowplugin.extension.api.OpenFlowPluginExtensionRegistratorProvider;
  47 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterManager;
  48 import org.opendaylight.openflowplugin.impl.connection.ConnectionManagerImpl;
  49 import org.opendaylight.openflowplugin.impl.device.DeviceManagerImpl;
  50 import org.opendaylight.openflowplugin.impl.rpc.RpcManagerImpl;
  51 import org.opendaylight.openflowplugin.impl.statistics.StatisticsManagerImpl;
  52 import org.opendaylight.openflowplugin.impl.statistics.ofpspecific.MessageIntelligenceAgencyImpl;
  53 import org.opendaylight.openflowplugin.impl.statistics.ofpspecific.MessageIntelligenceAgencyMXBean;
  54 import org.opendaylight.openflowplugin.impl.util.TranslatorLibraryUtil;
  55 import org.opendaylight.openflowplugin.openflow.md.core.ThreadPoolLoggingExecutor;
  56 import org.opendaylight.openflowplugin.openflow.md.core.extension.ExtensionConverterManagerImpl;
  57 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManager;
  58 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManagerFactory;
  59 import org.opendaylight.openflowplugin.openflow.md.core.session.OFSessionUtil;
  60 import org.slf4j.Logger;
  61 import org.slf4j.LoggerFactory;
  62 import io.netty.util.HashedWheelTimer;
  63
  64 public class OpenFlowPluginProviderImpl implements OpenFlowPluginProvider, OpenFlowPluginExtensionRegistratorProvider {
  65
  66     private static final Logger LOG = LoggerFactory.getLogger(OpenFlowPluginProviderImpl.class);
  67     private static final MessageIntelligenceAgency messageIntelligenceAgency = new MessageIntelligenceAgencyImpl();
  68     private static final int TICKS_PER_WHEEL = 500;
  69     // 0.5 sec.
  70     private static final long TICK_DURATION = 10;
  71     private static final Integer DEFAULT_BARRIER_COUNT = 25600;
  72     private static final Long DEFAULT_ECHO_TIMEOUT = 2000L;
  73     private static final Long DEFAULT_BARRIER_TIMEOUT = 500L;
  74
  75     private final HashedWheelTimer hashedWheelTimer = new HashedWheelTimer(TICK_DURATION, TimeUnit.MILLISECONDS, TICKS_PER_WHEEL);
  76
  77     private final int rpcRequestsQuota;
  78     private final long globalNotificationQuota;
  79     private final ConvertorManager convertorManager;
  80     private long barrierInterval;
  81     private int barrierCountLimit;
  82     private long echoReplyTimeout;
  83     private DeviceManager deviceManager;
  84     private RpcManager rpcManager;
  85     private RpcProviderRegistry rpcProviderRegistry;
  86     private StatisticsManager statisticsManager;
  87     private ConnectionManager connectionManager;
  88     private NotificationService notificationProviderService;
  89     private NotificationPublishService notificationPublishService;
  90     private EntityOwnershipService entityOwnershipService;
  91     private ClusterSingletonServiceProvider singletonServicesProvider;
  92     private ExtensionConverterManager extensionConverterManager;
  93     private DataBroker dataBroker;
  94     private Collection<SwitchConnectionProvider> switchConnectionProviders;
  95     private boolean switchFeaturesMandatory = false;
  96     private boolean isStatisticsPollingOn = true;
  97     private boolean isStatisticsRpcEnabled;
  98     private boolean isFlowRemovedNotificationOn = true;
  99     private boolean skipTableFeatures = true;
 100     private long basicTimerDelay;
 101     private long maximumTimerDelay;
 102
 103     private final ThreadPoolExecutor threadPool;
 104
 105     public OpenFlowPluginProviderImpl(final long rpcRequestsQuota,
 106                                       final long globalNotificationQuota,
 107                                       final int threadPoolMinThreads,
 108                                       final int threadPoolMaxThreads,
 109                                       final long threadPoolTimeout) {
 110         Preconditions.checkArgument(rpcRequestsQuota > 0 && rpcRequestsQuota <= Integer.MAX_VALUE, "rpcRequestQuota has to be in range <1,%s>", Integer.MAX_VALUE);
 111         this.rpcRequestsQuota = (int) rpcRequestsQuota;
 112         this.globalNotificationQuota = Preconditions.checkNotNull(globalNotificationQuota);
 113
 114         // Creates a thread pool that creates new threads as needed, but will reuse previously
 115         // constructed threads when they are available.
 116         // Threads that have not been used for x seconds are terminated and removed from the cache.
 117         threadPool = new ThreadPoolLoggingExecutor(
 118                 Preconditions.checkNotNull(threadPoolMinThreads),
 119                 Preconditions.checkNotNull(threadPoolMaxThreads),
 120                 Preconditions.checkNotNull(threadPoolTimeout), TimeUnit.SECONDS,
 121                 new SynchronousQueue<>(), "ofppool");
 122         convertorManager = ConvertorManagerFactory.createDefaultManager();
 123     }
 124
 125     @Override
 126     public boolean isStatisticsPollingOn() {
 127         return isStatisticsPollingOn;
 128     }
 129
 130     @Override
 131     public void setStatisticsPollingOn(final boolean isStatisticsPollingOn) {
 132         this.isStatisticsPollingOn = isStatisticsPollingOn;
 133     }
 134
 135     private void startSwitchConnections() {
 136         final List<ListenableFuture<Boolean>> starterChain = new ArrayList<>(switchConnectionProviders.size());
 137         for (final SwitchConnectionProvider switchConnectionPrv : switchConnectionProviders) {
 138             switchConnectionPrv.setSwitchConnectionHandler(connectionManager);
 139             final ListenableFuture<Boolean> isOnlineFuture = switchConnectionPrv.startup();
 140             starterChain.add(isOnlineFuture);
 141         }
 142
 143         final ListenableFuture<List<Boolean>> srvStarted = Futures.allAsList(starterChain);
 144         Futures.addCallback(srvStarted, new FutureCallback<List<Boolean>>() {
 145             @Override
 146             public void onSuccess(final List<Boolean> result) {
 147                 LOG.info("All switchConnectionProviders are up and running ({}).",
 148                         result.size());
 149             }
 150
 151             @Override
 152             public void onFailure(@Nonnull final Throwable t) {
 153                 LOG.warn("Some switchConnectionProviders failed to start.", t);
 154             }
 155         });
 156     }
 157
 158     @Override
 159     public boolean isSwitchFeaturesMandatory() {
 160         return switchFeaturesMandatory;
 161     }
 162
 163     @Override
 164     public void setBarrierCountLimit(final int barrierCountLimit) {
 165         this.barrierCountLimit = barrierCountLimit;
 166     }
 167
 168     @Override
 169     public void setBarrierInterval(final long barrierTimeoutLimit) {
 170         this.barrierInterval = barrierTimeoutLimit;
 171     }
 172
 173     @Override
 174     public void setEchoReplyTimeout(final long echoReplyTimeout) {
 175         this.echoReplyTimeout = echoReplyTimeout;
 176     }
 177
 178     @Override
 179     public void setFlowRemovedNotification(boolean isFlowRemovedNotificationOn) {
 180         this.isFlowRemovedNotificationOn = this.isFlowRemovedNotificationOn;
 181     }
 182
 183     @Override
 184     public void setClusteringSingletonServicesProvider(ClusterSingletonServiceProvider singletonServicesProvider) {
 185         this.singletonServicesProvider = singletonServicesProvider;
 186     }
 187
 188     @Override
 189     public void setEntityOwnershipServiceProvider(EntityOwnershipService entityOwnershipService) {
 190         this.entityOwnershipService = entityOwnershipService;
 191     }
 192
 193     @Override
 194     public void setSkipTableFeatures(final boolean skipTableFeatures){
 195             this.skipTableFeatures = skipTableFeatures;
 196     }
 197
 198     @Override
 199     public void setBasicTimerDelay(long basicTimerDelay) {
 200         this.basicTimerDelay = basicTimerDelay;
 201     }
 202
 203     @Override
 204     public void setMaximumTimerDelay(long maximumTimerDelay) {
 205         this.maximumTimerDelay = maximumTimerDelay;
 206     }
 207
 208     @Override
 209     public void setSwitchFeaturesMandatory(final boolean switchFeaturesMandatory) {
 210         this.switchFeaturesMandatory = switchFeaturesMandatory;
 211     }
 212
 213     public static MessageIntelligenceAgency getMessageIntelligenceAgency() {
 214         return OpenFlowPluginProviderImpl.messageIntelligenceAgency;
 215     }
 216
 217     @Override
 218     public void setSwitchConnectionProviders(final Collection<SwitchConnectionProvider> switchConnectionProviders) {
 219         this.switchConnectionProviders = switchConnectionProviders;
 220     }
 221
 222     @Override
 223     public void setDataBroker(final DataBroker dataBroker) {
 224         this.dataBroker = dataBroker;
 225     }
 226
 227     @Override
 228     public void setRpcProviderRegistry(final RpcProviderRegistry rpcProviderRegistry) {
 229         this.rpcProviderRegistry = rpcProviderRegistry;
 230     }
 231
 232     @Override
 233     public void initialize() {
 234         Preconditions.checkNotNull(dataBroker, "missing data broker");
 235         Preconditions.checkNotNull(rpcProviderRegistry, "missing RPC provider registry");
 236         Preconditions.checkNotNull(notificationProviderService, "missing notification provider service");
 237         Preconditions.checkNotNull(singletonServicesProvider, "missing singleton services provider");
 238
 239         extensionConverterManager = new ExtensionConverterManagerImpl();
 240         // TODO: copied from OpenFlowPluginProvider (Helium) misusesing the old way of distributing extension converters
 241         // TODO: rewrite later!
 242         OFSessionUtil.getSessionManager().setExtensionConverterProvider(extensionConverterManager);
 243
 244         connectionManager = new ConnectionManagerImpl(echoReplyTimeout, threadPool);
 245
 246         registerMXBean(messageIntelligenceAgency);
 247
 248         deviceManager = new DeviceManagerImpl(dataBroker,
 249                 globalNotificationQuota,
 250                 switchFeaturesMandatory,
 251                 barrierInterval,
 252                 barrierCountLimit,
 253                 getMessageIntelligenceAgency(),
 254                 isFlowRemovedNotificationOn,
 255                 singletonServicesProvider,
 256                 entityOwnershipService,
 257                 hashedWheelTimer,
 258                 convertorManager,
 259                 skipTableFeatures,
 260                 notificationPublishService);
 261
 262         ((ExtensionConverterProviderKeeper) deviceManager).setExtensionConverterProvider(extensionConverterManager);
 263
 264         rpcManager = new RpcManagerImpl(rpcProviderRegistry, rpcRequestsQuota, extensionConverterManager, convertorManager, notificationPublishService);
 265         statisticsManager = new StatisticsManagerImpl(rpcProviderRegistry, isStatisticsPollingOn, hashedWheelTimer,
 266                 convertorManager,basicTimerDelay,maximumTimerDelay);
 267
 268         /* Initialization Phase ordering - OFP Device Context suite */
 269         // CM -> DM -> SM -> RPC -> Role -> DM
 270         connectionManager.setDeviceConnectedHandler(deviceManager);
 271         deviceManager.setDeviceInitializationPhaseHandler(statisticsManager);
 272         statisticsManager.setDeviceInitializationPhaseHandler(rpcManager);
 273         rpcManager.setDeviceInitializationPhaseHandler(deviceManager);
 274
 275         /* Termination Phase ordering - OFP Device Context suite */
 276         deviceManager.setDeviceTerminationPhaseHandler(rpcManager);
 277         rpcManager.setDeviceTerminationPhaseHandler(statisticsManager);
 278         statisticsManager.setDeviceTerminationPhaseHandler(deviceManager);
 279
 280         rpcManager.setStatisticsRpcEnabled(isStatisticsRpcEnabled);
 281
 282         TranslatorLibraryUtil.injectBasicTranslatorLibrary(deviceManager, convertorManager);
 283         deviceManager.initialize();
 284
 285         startSwitchConnections();
 286     }
 287
 288     @Override
 289     public void update(Map<String,Object> props) {
 290         LOG.debug("Update managed properties = {}", props.toString());
 291
 292         if(deviceManager != null) {
 293             if (props.containsKey("notification-flow-removed-off")) {
 294                 deviceManager.setFlowRemovedNotificationOn(Boolean.valueOf(props.get("enable-flow-removed-notification").toString()));
 295             }
 296             if (props.containsKey("skip-table-features")) {
 297                 deviceManager.setSkipTableFeatures(Boolean.valueOf(props.get("skip-table-features").toString()));
 298             }
 299             if (props.containsKey("barrier-count-limit")) {
 300                 try {
 301                     deviceManager.setBarrierCountLimit(Integer.valueOf(props.get("barrier-count-limit").toString()));
 302                 } catch (NumberFormatException ex) {
 303                     deviceManager.setBarrierCountLimit(DEFAULT_BARRIER_COUNT);
 304                 }
 305             }
 306             if (props.containsKey("barrier-interval-timeout-limit")){
 307                 try {
 308                     deviceManager.setBarrierInterval(Long.valueOf(props.get("barrier-interval-timeout-limit").toString()));
 309                 } catch (NumberFormatException ex) {
 310                     deviceManager.setBarrierInterval(DEFAULT_BARRIER_TIMEOUT);
 311                 }
 312             }
 313         }
 314
 315         if(rpcManager != null && props.containsKey("is-statistics-rpc-enabled")){
 316             rpcManager.setStatisticsRpcEnabled(Boolean.valueOf((props.get("is-statistics-rpc-enabled").toString())));
 317         }
 318
 319         if (connectionManager != null && props.containsKey("echo-reply-timeout") ){
 320             try {
 321                 connectionManager.setEchoReplyTimeout(Long.valueOf(props.get("echo-reply-timeout").toString()));
 322             }catch (NumberFormatException ex){
 323                 connectionManager.setEchoReplyTimeout(DEFAULT_ECHO_TIMEOUT);
 324             }
 325         }
 326
 327         if(statisticsManager != null && props.containsKey("is-statistics-polling-on")){
 328             statisticsManager.setIsStatisticsPollingOn(Boolean.valueOf(props.get("is-statistics-polling-on").toString()));
 329         }
 330
 331         if(statisticsManager != null && props.containsKey("basic-timer-delay")){
 332             statisticsManager.setBasicTimerDelay(Long.valueOf(props.get("basic-timer-delay").toString()));
 333         }
 334
 335         if(statisticsManager != null && props.containsKey("maximum-timer-delay")){
 336             statisticsManager.setMaximumTimerDelay(Long.valueOf(props.get("maximum-timer-delay").toString()));
 337         }
 338     }
 339
 340
 341     private static void registerMXBean(final MessageIntelligenceAgency messageIntelligenceAgency) {
 342         final MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
 343         try {
 344             final String pathToMxBean = String.format("%s:type=%s",
 345                     MessageIntelligenceAgencyMXBean.class.getPackage().getName(),
 346                     MessageIntelligenceAgencyMXBean.class.getSimpleName());
 347             final ObjectName name = new ObjectName(pathToMxBean);
 348             mbs.registerMBean(messageIntelligenceAgency, name);
 349         } catch (MalformedObjectNameException
 350                 | NotCompliantMBeanException
 351                 | MBeanRegistrationException
 352                 | InstanceAlreadyExistsException e) {
 353             LOG.warn("Error registering MBean {}", e);
 354         }
 355     }
 356
 357     @Override
 358     public void setNotificationProviderService(final NotificationService notificationProviderService) {
 359         this.notificationProviderService = notificationProviderService;
 360     }
 361
 362     @Override
 363     public void setNotificationPublishService(final NotificationPublishService notificationPublishProviderService) {
 364         this.notificationPublishService = notificationPublishProviderService;
 365     }
 366
 367     @Override
 368     public ExtensionConverterRegistrator getExtensionConverterRegistrator() {
 369         return extensionConverterManager;
 370     }
 371
 372     @Override
 373     public void setIsStatisticsRpcEnabled(final boolean isStatisticsRpcEnabled) {
 374         this.isStatisticsRpcEnabled = isStatisticsRpcEnabled;
 375     }
 376
 377     @Override
 378     public void close() throws Exception {
 379         //TODO: consider wrapping each manager into try-catch
 380         deviceManager.close();
 381         rpcManager.close();
 382         statisticsManager.close();
 383
 384         // Manually shutdown all remaining running threads in pool
 385         threadPool.shutdown();
 386     }
 387 }