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.protocol.deserialization.DeserializerInjector;
  49 import org.opendaylight.openflowplugin.impl.protocol.serialization.SerializerInjector;
  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 ExtensionConverterManager extensionConverterManager;
  91     private DataBroker dataBroker;
  92     private Collection<SwitchConnectionProvider> switchConnectionProviders;
  93     private boolean switchFeaturesMandatory = false;
  94     private boolean isStatisticsPollingOn = true;
  95     private boolean isStatisticsRpcEnabled;
  96     private boolean isFlowRemovedNotificationOn = true;
  97     private boolean skipTableFeatures = true;
  98     private long basicTimerDelay;
  99     private long maximumTimerDelay;
 100     private boolean useSingleLayerSerialization = false;
 101
 102     private final ThreadPoolExecutor threadPool;
 103     private ClusterSingletonServiceProvider singletonServicesProvider;
 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         Futures.addCallback(Futures.allAsList(switchConnectionProviders.stream().map(switchConnectionProvider -> {
 137             // Inject OpenflowPlugin custom serializers and deserializers into OpenflowJava
 138             if (useSingleLayerSerialization) {
 139                 SerializerInjector.injectSerializers(switchConnectionProvider);
 140                 DeserializerInjector.injectDeserializers(switchConnectionProvider);
 141             }
 142
 143             // Set handler of incoming connections and start switch connection provider
 144             switchConnectionProvider.setSwitchConnectionHandler(connectionManager);
 145             return switchConnectionProvider.startup();
 146         }).collect(Collectors.toSet())), new FutureCallback<List<Boolean>>() {
 147             @Override
 148             public void onSuccess(final List<Boolean> result) {
 149                 LOG.info("All switchConnectionProviders are up and running ({}).", result.size());
 150             }
 151
 152             @Override
 153             public void onFailure(@Nonnull final Throwable t) {
 154                 LOG.warn("Some switchConnectionProviders failed to start.", t);
 155             }
 156         });
 157     }
 158
 159     @Override
 160     public boolean isSwitchFeaturesMandatory() {
 161         return switchFeaturesMandatory;
 162     }
 163
 164     @Override
 165     public void setBarrierCountLimit(final int barrierCountLimit) {
 166         this.barrierCountLimit = barrierCountLimit;
 167     }
 168
 169     @Override
 170     public void setBarrierInterval(final long barrierTimeoutLimit) {
 171         this.barrierInterval = barrierTimeoutLimit;
 172     }
 173
 174     @Override
 175     public void setEchoReplyTimeout(final long echoReplyTimeout) {
 176         this.echoReplyTimeout = echoReplyTimeout;
 177     }
 178
 179     @Override
 180     public void setFlowRemovedNotification(boolean isFlowRemovedNotificationOn) {
 181         this.isFlowRemovedNotificationOn = isFlowRemovedNotificationOn;
 182     }
 183
 184     @Override
 185     public void setClusteringSingletonServicesProvider(ClusterSingletonServiceProvider singletonServicesProvider) {
 186         this.singletonServicesProvider = singletonServicesProvider;
 187     }
 188
 189     @Override
 190     public void setSkipTableFeatures(final boolean skipTableFeatures){
 191         this.skipTableFeatures = skipTableFeatures;
 192     }
 193
 194     @Override
 195     public void setBasicTimerDelay(long basicTimerDelay) {
 196         this.basicTimerDelay = basicTimerDelay;
 197     }
 198
 199     @Override
 200     public void setMaximumTimerDelay(long maximumTimerDelay) {
 201         this.maximumTimerDelay = maximumTimerDelay;
 202     }
 203
 204     @Override
 205     public void setSwitchFeaturesMandatory(final boolean switchFeaturesMandatory) {
 206         this.switchFeaturesMandatory = switchFeaturesMandatory;
 207     }
 208
 209     public static MessageIntelligenceAgency getMessageIntelligenceAgency() {
 210         return OpenFlowPluginProviderImpl.messageIntelligenceAgency;
 211     }
 212
 213     @Override
 214     public void setSwitchConnectionProviders(final Collection<SwitchConnectionProvider> switchConnectionProviders) {
 215         this.switchConnectionProviders = switchConnectionProviders;
 216     }
 217
 218     @Override
 219     public void setDataBroker(final DataBroker dataBroker) {
 220         this.dataBroker = dataBroker;
 221     }
 222
 223     @Override
 224     public void setRpcProviderRegistry(final RpcProviderRegistry rpcProviderRegistry) {
 225         this.rpcProviderRegistry = rpcProviderRegistry;
 226     }
 227
 228     @Override
 229     public void initialize() {
 230         Preconditions.checkNotNull(dataBroker, "missing data broker");
 231         Preconditions.checkNotNull(rpcProviderRegistry, "missing RPC provider registry");
 232         Preconditions.checkNotNull(notificationProviderService, "missing notification provider service");
 233         Preconditions.checkNotNull(singletonServicesProvider, "missing singleton services provider");
 234
 235         extensionConverterManager = new ExtensionConverterManagerImpl();
 236         // TODO: copied from OpenFlowPluginProvider (Helium) misusesing the old way of distributing extension converters
 237         // TODO: rewrite later!
 238         OFSessionUtil.getSessionManager().setExtensionConverterProvider(extensionConverterManager);
 239
 240         connectionManager = new ConnectionManagerImpl(echoReplyTimeout, threadPool);
 241
 242         registerMXBean(messageIntelligenceAgency);
 243
 244         deviceManager = new DeviceManagerImpl(dataBroker,
 245                 globalNotificationQuota,
 246                 switchFeaturesMandatory,
 247                 barrierInterval,
 248                 barrierCountLimit,
 249                 getMessageIntelligenceAgency(),
 250                 isFlowRemovedNotificationOn,
 251                 singletonServicesProvider,
 252                 notificationPublishService,
 253                 hashedWheelTimer,
 254                 convertorManager,
 255                 skipTableFeatures,
 256                 useSingleLayerSerialization);
 257
 258         ((ExtensionConverterProviderKeeper) deviceManager).setExtensionConverterProvider(extensionConverterManager);
 259
 260         rpcManager = new RpcManagerImpl(rpcProviderRegistry, rpcRequestsQuota, extensionConverterManager, convertorManager, notificationPublishService);
 261         statisticsManager = new StatisticsManagerImpl(rpcProviderRegistry, isStatisticsPollingOn, hashedWheelTimer,
 262                 convertorManager,basicTimerDelay,maximumTimerDelay);
 263
 264         /* Initialization Phase ordering - OFP Device Context suite */
 265         // CM -> DM -> SM -> RPC -> Role -> DM
 266         connectionManager.setDeviceConnectedHandler(deviceManager);
 267         deviceManager.setDeviceInitializationPhaseHandler(statisticsManager);
 268         statisticsManager.setDeviceInitializationPhaseHandler(rpcManager);
 269         rpcManager.setDeviceInitializationPhaseHandler(deviceManager);
 270
 271         /* Termination Phase ordering - OFP Device Context suite */
 272         deviceManager.setDeviceTerminationPhaseHandler(rpcManager);
 273         rpcManager.setDeviceTerminationPhaseHandler(statisticsManager);
 274         statisticsManager.setDeviceTerminationPhaseHandler(deviceManager);
 275
 276         rpcManager.setStatisticsRpcEnabled(isStatisticsRpcEnabled);
 277
 278         TranslatorLibraryUtil.injectBasicTranslatorLibrary(deviceManager, convertorManager);
 279         deviceManager.initialize();
 280
 281         startSwitchConnections();
 282     }
 283
 284     @Override
 285     public void update(Map<String,Object> props) {
 286         LOG.debug("Update managed properties = {}", props.toString());
 287
 288         if(deviceManager != null) {
 289             if (props.containsKey("notification-flow-removed-off")) {
 290                 deviceManager.setFlowRemovedNotificationOn(Boolean.valueOf(props.get("enable-flow-removed-notification").toString()));
 291             }
 292             if (props.containsKey("skip-table-features")) {
 293                 deviceManager.setSkipTableFeatures(Boolean.valueOf(props.get("skip-table-features").toString()));
 294             }
 295             if (props.containsKey("barrier-count-limit")) {
 296                 try {
 297                     deviceManager.setBarrierCountLimit(Integer.valueOf(props.get("barrier-count-limit").toString()));
 298                 } catch (NumberFormatException ex) {
 299                     deviceManager.setBarrierCountLimit(DEFAULT_BARRIER_COUNT);
 300                 }
 301             }
 302             if (props.containsKey("barrier-interval-timeout-limit")){
 303                 try {
 304                     deviceManager.setBarrierInterval(Long.valueOf(props.get("barrier-interval-timeout-limit").toString()));
 305                 } catch (NumberFormatException ex) {
 306                     deviceManager.setBarrierInterval(DEFAULT_BARRIER_TIMEOUT);
 307                 }
 308             }
 309         }
 310
 311         if(rpcManager != null && props.containsKey("is-statistics-rpc-enabled")){
 312             rpcManager.setStatisticsRpcEnabled(Boolean.valueOf((props.get("is-statistics-rpc-enabled").toString())));
 313         }
 314
 315         if (connectionManager != null && props.containsKey("echo-reply-timeout") ){
 316             try {
 317                 connectionManager.setEchoReplyTimeout(Long.valueOf(props.get("echo-reply-timeout").toString()));
 318             }catch (NumberFormatException ex){
 319                 connectionManager.setEchoReplyTimeout(DEFAULT_ECHO_TIMEOUT);
 320             }
 321         }
 322
 323         if(statisticsManager != null && props.containsKey("is-statistics-polling-on")){
 324             statisticsManager.setIsStatisticsPollingOn(Boolean.valueOf(props.get("is-statistics-polling-on").toString()));
 325         }
 326
 327         if(statisticsManager != null && props.containsKey("basic-timer-delay")){
 328             statisticsManager.setBasicTimerDelay(Long.valueOf(props.get("basic-timer-delay").toString()));
 329         }
 330
 331         if(statisticsManager != null && props.containsKey("maximum-timer-delay")){
 332             statisticsManager.setMaximumTimerDelay(Long.valueOf(props.get("maximum-timer-delay").toString()));
 333         }
 334     }
 335
 336     private static void registerMXBean(final MessageIntelligenceAgency messageIntelligenceAgency) {
 337         final MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
 338         try {
 339             final String pathToMxBean = String.format("%s:type=%s",
 340                     MessageIntelligenceAgencyMXBean.class.getPackage().getName(),
 341                     MessageIntelligenceAgencyMXBean.class.getSimpleName());
 342             final ObjectName name = new ObjectName(pathToMxBean);
 343             mbs.registerMBean(messageIntelligenceAgency, name);
 344         } catch (MalformedObjectNameException
 345                 | NotCompliantMBeanException
 346                 | MBeanRegistrationException
 347                 | InstanceAlreadyExistsException e) {
 348             LOG.warn("Error registering MBean {}", e);
 349         }
 350     }
 351
 352     @Override
 353     public void setNotificationProviderService(final NotificationService notificationProviderService) {
 354         this.notificationProviderService = notificationProviderService;
 355     }
 356
 357     @Override
 358     public void setNotificationPublishService(final NotificationPublishService notificationPublishProviderService) {
 359         this.notificationPublishService = notificationPublishProviderService;
 360     }
 361
 362     @Override
 363     public ExtensionConverterRegistrator getExtensionConverterRegistrator() {
 364         return extensionConverterManager;
 365     }
 366
 367     @Override
 368     public void setIsStatisticsRpcEnabled(final boolean isStatisticsRpcEnabled) {
 369         this.isStatisticsRpcEnabled = isStatisticsRpcEnabled;
 370     }
 371
 372     @Override
 373     public void close() throws Exception {
 374         //TODO: consider wrapping each manager into try-catch
 375         deviceManager.close();
 376         rpcManager.close();
 377         statisticsManager.close();
 378
 379         // Manually shutdown all remaining running threads in pool
 380         threadPool.shutdown();
 381     }
 382
 383     @Override
 384     public void setIsUseSingleLayerSerialization(Boolean useSingleLayerSerialization) {
 385         this.useSingleLayerSerialization = useSingleLayerSerialization;
 386     }
 387 }