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