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
8 package org.opendaylight.openflowplugin.impl.device;
10 import com.google.common.annotations.VisibleForTesting;
11 import com.google.common.base.Function;
12 import com.google.common.base.Preconditions;
13 import com.google.common.base.Verify;
14 import com.google.common.collect.Iterators;
15 import com.google.common.util.concurrent.AsyncFunction;
16 import com.google.common.util.concurrent.FutureCallback;
17 import com.google.common.util.concurrent.Futures;
18 import com.google.common.util.concurrent.ListenableFuture;
19 import io.netty.util.TimerTask;
20 import java.util.Collections;
21 import java.util.HashSet;
22 import java.util.Iterator;
24 import java.util.concurrent.ConcurrentHashMap;
25 import java.util.concurrent.ConcurrentMap;
26 import java.util.concurrent.ExecutionException;
27 import java.util.concurrent.ScheduledThreadPoolExecutor;
28 import java.util.concurrent.TimeUnit;
29 import javax.annotation.CheckForNull;
30 import javax.annotation.Nonnull;
31 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
32 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
33 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
34 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
35 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueueHandlerRegistration;
36 import org.opendaylight.openflowplugin.api.openflow.OFPContext;
37 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
38 import org.opendaylight.openflowplugin.api.openflow.connection.OutboundQueueProvider;
39 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
40 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
41 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
42 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
43 import org.opendaylight.openflowplugin.api.openflow.device.DeviceSynchronizeListener;
44 import org.opendaylight.openflowplugin.api.openflow.device.DeviceValidListener;
45 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
46 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
47 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
48 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleConductor;
49 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
50 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterProviderKeeper;
51 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
52 import org.opendaylight.openflowplugin.impl.connection.OutboundQueueProviderImpl;
53 import org.opendaylight.openflowplugin.impl.device.listener.OpenflowProtocolListenerFullImpl;
54 import org.opendaylight.openflowplugin.impl.util.DeviceInitializationUtils;
55 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodesBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
60 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
61 import org.slf4j.Logger;
62 import org.slf4j.LoggerFactory;
67 public class DeviceManagerImpl implements DeviceManager, ExtensionConverterProviderKeeper {
69 private static final Logger LOG = LoggerFactory.getLogger(DeviceManagerImpl.class);
71 private final long globalNotificationQuota;
72 private final boolean switchFeaturesMandatory;
73 private boolean isNotificationFlowRemovedOff;
75 private static final int SPY_RATE = 10;
77 private final DataBroker dataBroker;
78 private final ConvertorExecutor convertorExecutor;
79 private TranslatorLibrary translatorLibrary;
80 private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
81 private DeviceTerminationPhaseHandler deviceTerminPhaseHandler;
83 private final ConcurrentMap<DeviceInfo, DeviceContext> deviceContexts = new ConcurrentHashMap<>();
85 private final long barrierIntervalNanos;
86 private final int barrierCountLimit;
87 private ExtensionConverterProvider extensionConverterProvider;
88 private ScheduledThreadPoolExecutor spyPool;
89 private Set<DeviceSynchronizeListener> deviceSynchronizedListeners;
90 private Set<DeviceValidListener> deviceValidListeners;
92 private final LifecycleConductor conductor;
94 public DeviceManagerImpl(@Nonnull final DataBroker dataBroker,
95 final long globalNotificationQuota, final boolean switchFeaturesMandatory,
96 final long barrierInterval, final int barrierCountLimit,
97 final LifecycleConductor lifecycleConductor, boolean isNotificationFlowRemovedOff,
98 final ConvertorExecutor convertorExecutor) {
99 this.switchFeaturesMandatory = switchFeaturesMandatory;
100 this.globalNotificationQuota = globalNotificationQuota;
101 this.isNotificationFlowRemovedOff = isNotificationFlowRemovedOff;
102 this.dataBroker = Preconditions.checkNotNull(dataBroker);
103 this.convertorExecutor = convertorExecutor;
104 /* merge empty nodes to oper DS to predict any problems with missing parent for Node */
105 final WriteTransaction tx = dataBroker.newWriteOnlyTransaction();
107 final NodesBuilder nodesBuilder = new NodesBuilder();
108 nodesBuilder.setNode(Collections.<Node>emptyList());
109 tx.merge(LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.create(Nodes.class), nodesBuilder.build());
112 } catch (ExecutionException | InterruptedException e) {
113 LOG.error("Creation of node failed.", e);
114 throw new IllegalStateException(e);
117 this.barrierIntervalNanos = TimeUnit.MILLISECONDS.toNanos(barrierInterval);
118 this.barrierCountLimit = barrierCountLimit;
120 this.conductor = lifecycleConductor;
121 spyPool = new ScheduledThreadPoolExecutor(1);
122 this.deviceSynchronizedListeners = new HashSet<>();
123 this.deviceValidListeners = new HashSet<>();
128 public void setDeviceInitializationPhaseHandler(final DeviceInitializationPhaseHandler handler) {
129 this.deviceInitPhaseHandler = handler;
133 public void onDeviceContextLevelUp(@CheckForNull DeviceInfo deviceInfo) throws Exception {
134 // final phase - we have to add new Device to MD-SAL DataStore
135 LOG.debug("Final phase of DeviceContextLevelUp for Node: {} ", deviceInfo.getNodeId());
136 DeviceContext deviceContext = Preconditions.checkNotNull(deviceContexts.get(deviceInfo));
137 deviceContext.onPublished();
141 public boolean deviceConnected(@CheckForNull final ConnectionContext connectionContext) throws Exception {
142 Preconditions.checkArgument(connectionContext != null);
144 DeviceInfo deviceInfo = connectionContext.getDeviceInfo();
146 * This part prevent destroy another device context. Throwing here an exception result to propagate close connection
147 * in {@link org.opendaylight.openflowplugin.impl.connection.org.opendaylight.openflowplugin.impl.connection.HandshakeContextImpl}
148 * If context already exist we are in state closing process (connection flapping) and we should not propagate connection close
150 if (deviceContexts.containsKey(deviceInfo)) {
151 LOG.warn("Rejecting connection from node which is already connected and there exist deviceContext for it: {}", connectionContext.getNodeId());
155 LOG.info("ConnectionEvent: Device connected to controller, Device:{}, NodeId:{}",
156 connectionContext.getConnectionAdapter().getRemoteAddress(), deviceInfo.getNodeId());
158 // Add Disconnect handler
159 connectionContext.setDeviceDisconnectedHandler(DeviceManagerImpl.this);
160 // Cache this for clarity
161 final ConnectionAdapter connectionAdapter = connectionContext.getConnectionAdapter();
163 //FIXME: as soon as auxiliary connection are fully supported then this is needed only before device context published
164 connectionAdapter.setPacketInFiltering(true);
166 final OutboundQueueProvider outboundQueueProvider = new OutboundQueueProviderImpl(deviceInfo.getVersion());
168 connectionContext.setOutboundQueueProvider(outboundQueueProvider);
169 final OutboundQueueHandlerRegistration<OutboundQueueProvider> outboundQueueHandlerRegistration =
170 connectionAdapter.registerOutboundQueueHandler(outboundQueueProvider, barrierCountLimit, barrierIntervalNanos);
171 connectionContext.setOutboundQueueHandleRegistration(outboundQueueHandlerRegistration);
173 final DeviceState deviceState = new DeviceStateImpl(deviceInfo);
174 this.addDeviceSynchronizeListener(deviceState);
175 this.addDeviceValidListener(deviceState);
177 final DeviceContext deviceContext = new DeviceContextImpl(connectionContext,
181 outboundQueueProvider,
185 Verify.verify(deviceContexts.putIfAbsent(deviceInfo, deviceContext) == null, "DeviceCtx still not closed.");
187 ((ExtensionConverterProviderKeeper) deviceContext).setExtensionConverterProvider(extensionConverterProvider);
188 deviceContext.setNotificationPublishService(conductor.getNotificationPublishService());
190 updatePacketInRateLimiters();
192 final OpenflowProtocolListenerFullImpl messageListener = new OpenflowProtocolListenerFullImpl(
193 connectionAdapter, deviceContext);
194 connectionAdapter.setMessageListener(messageListener);
195 notifyDeviceValidListeners(deviceInfo, true);
197 deviceInitPhaseHandler.onDeviceContextLevelUp(connectionContext.getDeviceInfo());
199 notifyDeviceSynchronizeListeners(deviceInfo, true);
204 private void updatePacketInRateLimiters() {
205 synchronized (deviceContexts) {
206 final int deviceContextsSize = deviceContexts.size();
207 if (deviceContextsSize > 0) {
208 long freshNotificationLimit = globalNotificationQuota / deviceContextsSize;
209 if (freshNotificationLimit < 100) {
210 freshNotificationLimit = 100;
212 LOG.debug("fresh notification limit = {}", freshNotificationLimit);
213 for (final DeviceContext deviceContext : deviceContexts.values()) {
214 deviceContext.updatePacketInRateLimit(freshNotificationLimit);
221 public TranslatorLibrary oook() {
222 return translatorLibrary;
226 public void setTranslatorLibrary(final TranslatorLibrary translatorLibrary) {
227 this.translatorLibrary = translatorLibrary;
231 public void close() {
232 for (final Iterator<DeviceContext> iterator = Iterators.consumingIterator(deviceContexts.values().iterator());
233 iterator.hasNext();) {
234 final DeviceContext deviceCtx = iterator.next();
235 notifyDeviceValidListeners(deviceCtx.getDeviceInfo(), false);
236 deviceCtx.shutdownConnection();
237 deviceCtx.shuttingDownDataStoreTransactions();
240 if (spyPool != null) {
241 spyPool.shutdownNow();
247 public void onDeviceContextLevelDown(final DeviceInfo deviceInfo) {
248 LOG.debug("onDeviceContextClosed for Node {}", deviceInfo.getNodeId());
249 deviceContexts.remove(deviceInfo);
250 updatePacketInRateLimiters();
254 public void initialize() {
255 spyPool.scheduleAtFixedRate(conductor.getMessageIntelligenceAgency(), SPY_RATE, SPY_RATE, TimeUnit.SECONDS);
259 public void setExtensionConverterProvider(final ExtensionConverterProvider extensionConverterProvider) {
260 this.extensionConverterProvider = extensionConverterProvider;
264 public ExtensionConverterProvider getExtensionConverterProvider() {
265 return extensionConverterProvider;
269 public void setDeviceTerminationPhaseHandler(final DeviceTerminationPhaseHandler handler) {
270 this.deviceTerminPhaseHandler = handler;
274 public void onDeviceDisconnected(final ConnectionContext connectionContext) {
275 LOG.trace("onDeviceDisconnected method call for Node: {}", connectionContext.getNodeId());
276 final DeviceInfo deviceInfo = connectionContext.getDeviceInfo();
277 final DeviceContext deviceCtx = this.deviceContexts.get(deviceInfo);
279 if (null == deviceCtx) {
280 LOG.info("DeviceContext for Node {} was not found. Connection is terminated without OFP context suite.", deviceInfo.getNodeId());
284 if (!connectionContext.equals(deviceCtx.getPrimaryConnectionContext())) {
285 /* Connection is not PrimaryConnection so try to remove from Auxiliary Connections */
286 deviceCtx.removeAuxiliaryConnectionContext(connectionContext);
288 notifyDeviceValidListeners(deviceInfo, false);
289 /* Device is disconnected and so we need to close TxManager */
290 final ListenableFuture<Void> future = deviceCtx.shuttingDownDataStoreTransactions();
291 Futures.addCallback(future, new FutureCallback<Void>() {
294 public void onSuccess(final Void result) {
295 LOG.debug("TxChainManager for device {} is closed successful.", deviceInfo.getNodeId());
296 deviceTerminPhaseHandler.onDeviceContextLevelDown(deviceInfo);
300 public void onFailure(final Throwable t) {
301 LOG.warn("TxChainManager for device {} failed by closing.", deviceInfo.getNodeId(), t);
302 deviceTerminPhaseHandler.onDeviceContextLevelDown(deviceInfo);
305 /* Add timer for Close TxManager because it could fain ind cluster without notification */
306 final TimerTask timerTask = timeout -> {
307 if (!future.isDone()) {
308 LOG.info("Shutting down TxChain for node {} not completed during 10 sec. Continue anyway.", deviceInfo.getNodeId());
309 future.cancel(false);
312 conductor.newTimeout(timerTask, 10, TimeUnit.SECONDS);
317 void addDeviceContextToMap(final DeviceInfo deviceInfo, final DeviceContext deviceContext){
318 deviceContexts.put(deviceInfo, deviceContext);
322 public <T extends OFPContext> T gainContext(final DeviceInfo deviceInfo) {
323 return (T) deviceContexts.get(deviceInfo);
327 public ListenableFuture<Void> onClusterRoleChange(final DeviceInfo deviceInfo, final OfpRole role) {
328 DeviceContext deviceContext = deviceContexts.get(deviceInfo);
329 LOG.trace("onClusterRoleChange {} for node:", role, deviceInfo.getNodeId());
330 if (OfpRole.BECOMEMASTER.equals(role)) {
331 return onDeviceTakeClusterLeadership(deviceInfo);
333 return ((DeviceContextImpl)deviceContext).getTransactionChainManager().deactivateTransactionManager();
337 public void addDeviceSynchronizeListener(final DeviceSynchronizeListener deviceSynchronizeListener) {
338 this.deviceSynchronizedListeners.add(deviceSynchronizeListener);
342 public void notifyDeviceSynchronizeListeners(final DeviceInfo deviceInfo, final boolean deviceSynchronized) {
343 for (DeviceSynchronizeListener listener : deviceSynchronizedListeners) {
344 listener.deviceIsSynchronized(deviceInfo, deviceSynchronized);
349 public void addDeviceValidListener(final DeviceValidListener deviceValidListener) {
350 this.deviceValidListeners.add(deviceValidListener);
354 public void notifyDeviceValidListeners(final DeviceInfo deviceInfo, final boolean deviceValid) {
355 for (DeviceValidListener listener : deviceValidListeners) {
356 listener.deviceIsValid(deviceInfo, deviceValid);
361 public void setIsNotificationFlowRemovedOff(boolean isNotificationFlowRemovedOff) {
362 this.isNotificationFlowRemovedOff = isNotificationFlowRemovedOff;
366 public boolean getIsNotificationFlowRemovedOff() {
367 return this.isNotificationFlowRemovedOff;
370 private ListenableFuture<Void> onDeviceTakeClusterLeadership(final DeviceInfo deviceInfo) {
371 LOG.trace("onDeviceTakeClusterLeadership for node: {}", deviceInfo.getNodeId());
373 StatisticsContext statisticsContext = conductor.getStatisticsContext(deviceInfo);
374 if (statisticsContext == null) {
375 final String errMsg = String.format("DeviceCtx %s is up but we are missing StatisticsContext", deviceInfo.getDatapathId());
377 return Futures.immediateFailedFuture(new IllegalStateException(errMsg));
379 DeviceContext deviceContext = deviceContexts.get(deviceInfo);
380 /* Prepare init info collecting */
381 notifyDeviceSynchronizeListeners(deviceInfo, false);
382 ((DeviceContextImpl)deviceContext).getTransactionChainManager().activateTransactionManager();
383 ((DeviceContextImpl)deviceContext).getTransactionChainManager().initialSubmitWriteTransaction();
384 /* Init Collecting NodeInfo */
385 final ListenableFuture<Void> initCollectingDeviceInfo = DeviceInitializationUtils.initializeNodeInformation(
386 deviceContext, switchFeaturesMandatory, convertorExecutor);
387 /* Init Collecting StatInfo */
388 final ListenableFuture<Boolean> statPollFuture = Futures.transform(initCollectingDeviceInfo,
389 new AsyncFunction<Void, Boolean>() {
392 public ListenableFuture<Boolean> apply(@Nonnull final Void input) throws Exception {
393 statisticsContext.statListForCollectingInitialization();
394 return statisticsContext.initialGatherDynamicData();
398 return Futures.transform(statPollFuture, getInitialDeviceInformation(deviceContext));
401 private Function<Boolean, Void> getInitialDeviceInformation(final DeviceContext deviceContext) {
403 if (ConnectionContext.CONNECTION_STATE.RIP.equals(
404 conductor.gainConnectionStateSafely(deviceContext.getDeviceInfo())
406 final String errMsg =
407 String.format("We lost connection for Device %s, context has to be closed.",
408 deviceContext.getDeviceInfo().getNodeId());
410 throw new IllegalStateException(errMsg);
413 if (input == null || !input) {
414 final String errMsg =
415 String.format("Get Initial Device %s information fails",
416 deviceContext.getDeviceInfo().getNodeId());
418 throw new IllegalStateException(errMsg);
420 LOG.debug("Get Initial Device {} information is successful",
421 deviceContext.getDeviceInfo().getNodeId());
422 notifyDeviceSynchronizeListeners(deviceContext.getDeviceInfo(), true);
423 deviceContext.getDeviceState().setStatisticsPollingEnabledProp(true);