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