2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.openflowplugin.impl;
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;
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.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.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.rpc.RpcManagerImpl;
50 import org.opendaylight.openflowplugin.impl.statistics.StatisticsManagerImpl;
51 import org.opendaylight.openflowplugin.impl.statistics.ofpspecific.MessageIntelligenceAgencyImpl;
52 import org.opendaylight.openflowplugin.impl.statistics.ofpspecific.MessageIntelligenceAgencyMXBean;
53 import org.opendaylight.openflowplugin.impl.util.TranslatorLibraryUtil;
54 import org.opendaylight.openflowplugin.openflow.md.core.ThreadPoolLoggingExecutor;
55 import org.opendaylight.openflowplugin.openflow.md.core.extension.ExtensionConverterManagerImpl;
56 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManager;
57 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManagerFactory;
58 import org.opendaylight.openflowplugin.openflow.md.core.session.OFSessionUtil;
59 import org.slf4j.Logger;
60 import org.slf4j.LoggerFactory;
61 import io.netty.util.HashedWheelTimer;
63 public class OpenFlowPluginProviderImpl implements OpenFlowPluginProvider, OpenFlowPluginExtensionRegistratorProvider {
65 private static final Logger LOG = LoggerFactory.getLogger(OpenFlowPluginProviderImpl.class);
66 private static final MessageIntelligenceAgency messageIntelligenceAgency = new MessageIntelligenceAgencyImpl();
67 private static final int TICKS_PER_WHEEL = 500;
69 private static final long TICK_DURATION = 10;
70 private static final Integer DEFAULT_BARRIER_COUNT = 25600;
71 private static final Long DEFAULT_ECHO_TIMEOUT = 2000L;
72 private static final Long DEFAULT_BARRIER_TIMEOUT = 500L;
74 private final HashedWheelTimer hashedWheelTimer = new HashedWheelTimer(TICK_DURATION, TimeUnit.MILLISECONDS, TICKS_PER_WHEEL);
76 private final int rpcRequestsQuota;
77 private final long globalNotificationQuota;
78 private final ConvertorManager convertorManager;
79 private long barrierInterval;
80 private int barrierCountLimit;
81 private long echoReplyTimeout;
82 private DeviceManager deviceManager;
83 private RpcManager rpcManager;
84 private RpcProviderRegistry rpcProviderRegistry;
85 private StatisticsManager statisticsManager;
86 private ConnectionManager connectionManager;
87 private NotificationService notificationProviderService;
88 private NotificationPublishService notificationPublishService;
89 private ExtensionConverterManager extensionConverterManager;
90 private DataBroker dataBroker;
91 private Collection<SwitchConnectionProvider> switchConnectionProviders;
92 private boolean switchFeaturesMandatory = false;
93 private boolean isStatisticsPollingOn = true;
94 private boolean isStatisticsRpcEnabled;
95 private boolean isFlowRemovedNotificationOn = true;
96 private boolean skipTableFeatures = true;
97 private long basicTimerDelay;
98 private long maximumTimerDelay;
100 private final ThreadPoolExecutor threadPool;
101 private ClusterSingletonServiceProvider singletonServicesProvider;
103 public OpenFlowPluginProviderImpl(final long rpcRequestsQuota,
104 final long globalNotificationQuota,
105 final int threadPoolMinThreads,
106 final int threadPoolMaxThreads,
107 final long threadPoolTimeout) {
108 Preconditions.checkArgument(rpcRequestsQuota > 0 && rpcRequestsQuota <= Integer.MAX_VALUE, "rpcRequestQuota has to be in range <1,%s>", Integer.MAX_VALUE);
109 this.rpcRequestsQuota = (int) rpcRequestsQuota;
110 this.globalNotificationQuota = Preconditions.checkNotNull(globalNotificationQuota);
112 // Creates a thread pool that creates new threads as needed, but will reuse previously
113 // constructed threads when they are available.
114 // Threads that have not been used for x seconds are terminated and removed from the cache.
115 threadPool = new ThreadPoolLoggingExecutor(
116 Preconditions.checkNotNull(threadPoolMinThreads),
117 Preconditions.checkNotNull(threadPoolMaxThreads),
118 Preconditions.checkNotNull(threadPoolTimeout), TimeUnit.SECONDS,
119 new SynchronousQueue<>(), "ofppool");
120 convertorManager = ConvertorManagerFactory.createDefaultManager();
124 public boolean isStatisticsPollingOn() {
125 return isStatisticsPollingOn;
129 public void setStatisticsPollingOn(final boolean isStatisticsPollingOn) {
130 this.isStatisticsPollingOn = isStatisticsPollingOn;
133 private void startSwitchConnections() {
134 final List<ListenableFuture<Boolean>> starterChain = new ArrayList<>(switchConnectionProviders.size());
135 for (final SwitchConnectionProvider switchConnectionPrv : switchConnectionProviders) {
136 switchConnectionPrv.setSwitchConnectionHandler(connectionManager);
137 final ListenableFuture<Boolean> isOnlineFuture = switchConnectionPrv.startup();
138 starterChain.add(isOnlineFuture);
141 final ListenableFuture<List<Boolean>> srvStarted = Futures.allAsList(starterChain);
142 Futures.addCallback(srvStarted, new FutureCallback<List<Boolean>>() {
144 public void onSuccess(final List<Boolean> result) {
145 LOG.info("All switchConnectionProviders are up and running ({}).",
150 public void onFailure(@Nonnull final Throwable t) {
151 LOG.warn("Some switchConnectionProviders failed to start.", t);
157 public boolean isSwitchFeaturesMandatory() {
158 return switchFeaturesMandatory;
162 public void setBarrierCountLimit(final int barrierCountLimit) {
163 this.barrierCountLimit = barrierCountLimit;
167 public void setBarrierInterval(final long barrierTimeoutLimit) {
168 this.barrierInterval = barrierTimeoutLimit;
172 public void setEchoReplyTimeout(final long echoReplyTimeout) {
173 this.echoReplyTimeout = echoReplyTimeout;
177 public void setFlowRemovedNotification(boolean isFlowRemovedNotificationOn) {
178 this.isFlowRemovedNotificationOn = this.isFlowRemovedNotificationOn;
182 public void setClusteringSingletonServicesProvider(ClusterSingletonServiceProvider singletonServicesProvider) {
183 this.singletonServicesProvider = singletonServicesProvider;
187 public void setSkipTableFeatures(final boolean skipTableFeatures){
188 this.skipTableFeatures = skipTableFeatures;
192 public void setBasicTimerDelay(long basicTimerDelay) {
193 this.basicTimerDelay = basicTimerDelay;
197 public void setMaximumTimerDelay(long maximumTimerDelay) {
198 this.maximumTimerDelay = maximumTimerDelay;
202 public void setSwitchFeaturesMandatory(final boolean switchFeaturesMandatory) {
203 this.switchFeaturesMandatory = switchFeaturesMandatory;
206 public static MessageIntelligenceAgency getMessageIntelligenceAgency() {
207 return OpenFlowPluginProviderImpl.messageIntelligenceAgency;
211 public void setSwitchConnectionProviders(final Collection<SwitchConnectionProvider> switchConnectionProviders) {
212 this.switchConnectionProviders = switchConnectionProviders;
216 public void setDataBroker(final DataBroker dataBroker) {
217 this.dataBroker = dataBroker;
221 public void setRpcProviderRegistry(final RpcProviderRegistry rpcProviderRegistry) {
222 this.rpcProviderRegistry = rpcProviderRegistry;
226 public void initialize() {
227 Preconditions.checkNotNull(dataBroker, "missing data broker");
228 Preconditions.checkNotNull(rpcProviderRegistry, "missing RPC provider registry");
229 Preconditions.checkNotNull(notificationProviderService, "missing notification provider service");
230 Preconditions.checkNotNull(singletonServicesProvider, "missing singleton services provider");
232 extensionConverterManager = new ExtensionConverterManagerImpl();
233 // TODO: copied from OpenFlowPluginProvider (Helium) misusesing the old way of distributing extension converters
234 // TODO: rewrite later!
235 OFSessionUtil.getSessionManager().setExtensionConverterProvider(extensionConverterManager);
237 connectionManager = new ConnectionManagerImpl(echoReplyTimeout, threadPool);
239 registerMXBean(messageIntelligenceAgency);
241 deviceManager = new DeviceManagerImpl(dataBroker,
242 globalNotificationQuota,
243 switchFeaturesMandatory,
246 getMessageIntelligenceAgency(),
247 isFlowRemovedNotificationOn,
248 singletonServicesProvider,
249 notificationPublishService,
254 ((ExtensionConverterProviderKeeper) deviceManager).setExtensionConverterProvider(extensionConverterManager);
256 rpcManager = new RpcManagerImpl(rpcProviderRegistry, rpcRequestsQuota, extensionConverterManager, convertorManager, notificationPublishService);
257 statisticsManager = new StatisticsManagerImpl(rpcProviderRegistry, isStatisticsPollingOn, hashedWheelTimer,
258 convertorManager,basicTimerDelay,maximumTimerDelay);
260 /* Initialization Phase ordering - OFP Device Context suite */
261 // CM -> DM -> SM -> RPC -> Role -> DM
262 connectionManager.setDeviceConnectedHandler(deviceManager);
263 deviceManager.setDeviceInitializationPhaseHandler(statisticsManager);
264 statisticsManager.setDeviceInitializationPhaseHandler(rpcManager);
265 rpcManager.setDeviceInitializationPhaseHandler(deviceManager);
267 /* Termination Phase ordering - OFP Device Context suite */
268 deviceManager.setDeviceTerminationPhaseHandler(rpcManager);
269 rpcManager.setDeviceTerminationPhaseHandler(statisticsManager);
270 statisticsManager.setDeviceTerminationPhaseHandler(deviceManager);
272 rpcManager.setStatisticsRpcEnabled(isStatisticsRpcEnabled);
274 TranslatorLibraryUtil.injectBasicTranslatorLibrary(deviceManager, convertorManager);
275 deviceManager.initialize();
277 startSwitchConnections();
281 public void update(Map<String,Object> props) {
282 LOG.debug("Update managed properties = {}", props.toString());
284 if(deviceManager != null) {
285 if (props.containsKey("notification-flow-removed-off")) {
286 deviceManager.setFlowRemovedNotificationOn(Boolean.valueOf(props.get("enable-flow-removed-notification").toString()));
288 if (props.containsKey("skip-table-features")) {
289 deviceManager.setSkipTableFeatures(Boolean.valueOf(props.get("skip-table-features").toString()));
291 if (props.containsKey("barrier-count-limit")) {
293 deviceManager.setBarrierCountLimit(Integer.valueOf(props.get("barrier-count-limit").toString()));
294 } catch (NumberFormatException ex) {
295 deviceManager.setBarrierCountLimit(DEFAULT_BARRIER_COUNT);
298 if (props.containsKey("barrier-interval-timeout-limit")){
300 deviceManager.setBarrierInterval(Long.valueOf(props.get("barrier-interval-timeout-limit").toString()));
301 } catch (NumberFormatException ex) {
302 deviceManager.setBarrierInterval(DEFAULT_BARRIER_TIMEOUT);
307 if(rpcManager != null && props.containsKey("is-statistics-rpc-enabled")){
308 rpcManager.setStatisticsRpcEnabled(Boolean.valueOf((props.get("is-statistics-rpc-enabled").toString())));
311 if (connectionManager != null && props.containsKey("echo-reply-timeout") ){
313 connectionManager.setEchoReplyTimeout(Long.valueOf(props.get("echo-reply-timeout").toString()));
314 }catch (NumberFormatException ex){
315 connectionManager.setEchoReplyTimeout(DEFAULT_ECHO_TIMEOUT);
319 if(statisticsManager != null && props.containsKey("is-statistics-polling-on")){
320 statisticsManager.setIsStatisticsPollingOn(Boolean.valueOf(props.get("is-statistics-polling-on").toString()));
323 if(statisticsManager != null && props.containsKey("basic-timer-delay")){
324 statisticsManager.setBasicTimerDelay(Long.valueOf(props.get("basic-timer-delay").toString()));
327 if(statisticsManager != null && props.containsKey("maximum-timer-delay")){
328 statisticsManager.setMaximumTimerDelay(Long.valueOf(props.get("maximum-timer-delay").toString()));
333 private static void registerMXBean(final MessageIntelligenceAgency messageIntelligenceAgency) {
334 final MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
336 final String pathToMxBean = String.format("%s:type=%s",
337 MessageIntelligenceAgencyMXBean.class.getPackage().getName(),
338 MessageIntelligenceAgencyMXBean.class.getSimpleName());
339 final ObjectName name = new ObjectName(pathToMxBean);
340 mbs.registerMBean(messageIntelligenceAgency, name);
341 } catch (MalformedObjectNameException
342 | NotCompliantMBeanException
343 | MBeanRegistrationException
344 | InstanceAlreadyExistsException e) {
345 LOG.warn("Error registering MBean {}", e);
350 public void setNotificationProviderService(final NotificationService notificationProviderService) {
351 this.notificationProviderService = notificationProviderService;
355 public void setNotificationPublishService(final NotificationPublishService notificationPublishProviderService) {
356 this.notificationPublishService = notificationPublishProviderService;
360 public ExtensionConverterRegistrator getExtensionConverterRegistrator() {
361 return extensionConverterManager;
365 public void setIsStatisticsRpcEnabled(final boolean isStatisticsRpcEnabled) {
366 this.isStatisticsRpcEnabled = isStatisticsRpcEnabled;
370 public void close() throws Exception {
371 //TODO: consider wrapping each manager into try-catch
372 deviceManager.close();
374 statisticsManager.close();
376 // Manually shutdown all remaining running threads in pool
377 threadPool.shutdown();