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