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;
21 import java.util.ArrayList;
22 import java.util.Collections;
23 import java.util.Iterator;
24 import java.util.List;
25 import java.util.concurrent.ConcurrentHashMap;
26 import java.util.concurrent.ConcurrentMap;
27 import java.util.concurrent.ExecutionException;
28 import java.util.concurrent.ScheduledThreadPoolExecutor;
29 import java.util.concurrent.TimeUnit;
30 import javax.annotation.CheckForNull;
31 import javax.annotation.Nonnull;
32 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
33 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
34 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
35 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
36 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueueHandlerRegistration;
37 import org.opendaylight.openflowplugin.api.openflow.OFPContext;
38 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
39 import org.opendaylight.openflowplugin.api.openflow.connection.OutboundQueueProvider;
40 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
41 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
42 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
43 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
44 import org.opendaylight.openflowplugin.api.openflow.device.DeviceSynchronizeListener;
45 import org.opendaylight.openflowplugin.api.openflow.device.DeviceValidListener;
46 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
47 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
48 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
49 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleConductor;
50 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
51 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterProviderKeeper;
52 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
53 import org.opendaylight.openflowplugin.impl.connection.OutboundQueueProviderImpl;
54 import org.opendaylight.openflowplugin.impl.device.listener.OpenflowProtocolListenerFullImpl;
55 import org.opendaylight.openflowplugin.impl.util.DeviceInitializationUtils;
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;
74 private final int spyRate = 10;
76 private final DataBroker dataBroker;
77 private TranslatorLibrary translatorLibrary;
78 private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
79 private DeviceTerminationPhaseHandler deviceTerminPhaseHandler;
81 private final ConcurrentMap<DeviceInfo, DeviceContext> deviceContexts = new ConcurrentHashMap<>();
83 private final long barrierIntervalNanos;
84 private final int barrierCountLimit;
85 private ExtensionConverterProvider extensionConverterProvider;
86 private ScheduledThreadPoolExecutor spyPool;
87 private List<DeviceSynchronizeListener> deviceSynchronizedListeners;
88 private List<DeviceValidListener> deviceValidListeners;
90 private final LifecycleConductor conductor;
92 public DeviceManagerImpl(@Nonnull final DataBroker dataBroker,
93 final long globalNotificationQuota, final boolean switchFeaturesMandatory,
94 final long barrierInterval, final int barrierCountLimit,
95 final LifecycleConductor lifecycleConductor) {
96 this.switchFeaturesMandatory = switchFeaturesMandatory;
97 this.globalNotificationQuota = globalNotificationQuota;
98 this.dataBroker = Preconditions.checkNotNull(dataBroker);
99 /* merge empty nodes to oper DS to predict any problems with missing parent for Node */
100 final WriteTransaction tx = dataBroker.newWriteOnlyTransaction();
102 final NodesBuilder nodesBuilder = new NodesBuilder();
103 nodesBuilder.setNode(Collections.<Node>emptyList());
104 tx.merge(LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.create(Nodes.class), nodesBuilder.build());
107 } catch (ExecutionException | InterruptedException e) {
108 LOG.error("Creation of node failed.", e);
109 throw new IllegalStateException(e);
112 this.barrierIntervalNanos = TimeUnit.MILLISECONDS.toNanos(barrierInterval);
113 this.barrierCountLimit = barrierCountLimit;
115 this.conductor = lifecycleConductor;
116 spyPool = new ScheduledThreadPoolExecutor(1);
117 this.deviceSynchronizedListeners = new ArrayList<>();
118 this.deviceValidListeners = new ArrayList<>();
123 public void setDeviceInitializationPhaseHandler(final DeviceInitializationPhaseHandler handler) {
124 this.deviceInitPhaseHandler = handler;
128 public void onDeviceContextLevelUp(@CheckForNull DeviceInfo deviceInfo) throws Exception {
129 // final phase - we have to add new Device to MD-SAL DataStore
130 LOG.debug("Final phase of DeviceContextLevelUp for Node: {} ", deviceInfo.getNodeId());
131 DeviceContext deviceContext = Preconditions.checkNotNull(deviceContexts.get(deviceInfo));
132 ((DeviceContextImpl) deviceContext).initialSubmitTransaction();
133 deviceContext.onPublished();
137 public boolean deviceConnected(@CheckForNull final ConnectionContext connectionContext) throws Exception {
138 Preconditions.checkArgument(connectionContext != null);
140 DeviceInfo deviceInfo = connectionContext.getDeviceInfo();
142 * This part prevent destroy another device context. Throwing here an exception result to propagate close connection
143 * in {@link org.opendaylight.openflowplugin.impl.connection.org.opendaylight.openflowplugin.impl.connection.HandshakeContextImpl}
144 * If context already exist we are in state closing process (connection flapping) and we should not propagate connection close
146 if (deviceContexts.containsKey(deviceInfo)) {
147 LOG.warn("Rejecting connection from node which is already connected and there exist deviceContext for it: {}", connectionContext.getNodeId());
151 LOG.info("ConnectionEvent: Device connected to controller, Device:{}, NodeId:{}",
152 connectionContext.getConnectionAdapter().getRemoteAddress(), deviceInfo.getNodeId());
154 // Add Disconnect handler
155 connectionContext.setDeviceDisconnectedHandler(DeviceManagerImpl.this);
156 // Cache this for clarity
157 final ConnectionAdapter connectionAdapter = connectionContext.getConnectionAdapter();
159 //FIXME: as soon as auxiliary connection are fully supported then this is needed only before device context published
160 connectionAdapter.setPacketInFiltering(true);
162 final OutboundQueueProvider outboundQueueProvider = new OutboundQueueProviderImpl(deviceInfo.getVersion());
164 connectionContext.setOutboundQueueProvider(outboundQueueProvider);
165 final OutboundQueueHandlerRegistration<OutboundQueueProvider> outboundQueueHandlerRegistration =
166 connectionAdapter.registerOutboundQueueHandler(outboundQueueProvider, barrierCountLimit, barrierIntervalNanos);
167 connectionContext.setOutboundQueueHandleRegistration(outboundQueueHandlerRegistration);
169 final DeviceState deviceState = new DeviceStateImpl(deviceInfo);
170 this.registerDeviceSynchronizeListeners(deviceState);
171 this.registerDeviceValidListeners(deviceState);
173 final DeviceContext deviceContext = new DeviceContextImpl(connectionContext,
177 outboundQueueProvider,
180 Verify.verify(deviceContexts.putIfAbsent(deviceInfo, deviceContext) == null, "DeviceCtx still not closed.");
182 ((ExtensionConverterProviderKeeper) deviceContext).setExtensionConverterProvider(extensionConverterProvider);
183 deviceContext.setNotificationPublishService(conductor.getNotificationPublishService());
185 updatePacketInRateLimiters();
187 final OpenflowProtocolListenerFullImpl messageListener = new OpenflowProtocolListenerFullImpl(
188 connectionAdapter, deviceContext);
189 connectionAdapter.setMessageListener(messageListener);
190 notifyDeviceValidListeners(deviceInfo, true);
192 deviceInitPhaseHandler.onDeviceContextLevelUp(connectionContext.getDeviceInfo());
194 notifyDeviceSynchronizeListeners(deviceInfo, true);
199 private void updatePacketInRateLimiters() {
200 synchronized (deviceContexts) {
201 final int deviceContextsSize = deviceContexts.size();
202 if (deviceContextsSize > 0) {
203 long freshNotificationLimit = globalNotificationQuota / deviceContextsSize;
204 if (freshNotificationLimit < 100) {
205 freshNotificationLimit = 100;
207 LOG.debug("fresh notification limit = {}", freshNotificationLimit);
208 for (final DeviceContext deviceContext : deviceContexts.values()) {
209 deviceContext.updatePacketInRateLimit(freshNotificationLimit);
216 public TranslatorLibrary oook() {
217 return translatorLibrary;
221 public void setTranslatorLibrary(final TranslatorLibrary translatorLibrary) {
222 this.translatorLibrary = translatorLibrary;
226 public void close() {
227 for (final Iterator<DeviceContext> iterator = Iterators.consumingIterator(deviceContexts.values().iterator());
228 iterator.hasNext();) {
229 final DeviceContext deviceCtx = iterator.next();
230 notifyDeviceValidListeners(deviceCtx.getDeviceInfo(), false);
231 deviceCtx.shutdownConnection();
232 deviceCtx.shuttingDownDataStoreTransactions();
235 if (spyPool != null) {
236 spyPool.shutdownNow();
242 public void onDeviceContextLevelDown(final DeviceInfo deviceInfo) {
243 LOG.debug("onDeviceContextClosed for Node {}", deviceInfo.getNodeId());
244 deviceContexts.remove(deviceInfo);
245 updatePacketInRateLimiters();
249 public void initialize() {
250 spyPool.scheduleAtFixedRate(conductor.getMessageIntelligenceAgency(), spyRate, spyRate, TimeUnit.SECONDS);
254 public void setExtensionConverterProvider(final ExtensionConverterProvider extensionConverterProvider) {
255 this.extensionConverterProvider = extensionConverterProvider;
259 public ExtensionConverterProvider getExtensionConverterProvider() {
260 return extensionConverterProvider;
264 public void setDeviceTerminationPhaseHandler(final DeviceTerminationPhaseHandler handler) {
265 this.deviceTerminPhaseHandler = handler;
269 public void onDeviceDisconnected(final ConnectionContext connectionContext) {
270 LOG.trace("onDeviceDisconnected method call for Node: {}", connectionContext.getNodeId());
271 final DeviceInfo deviceInfo = connectionContext.getDeviceInfo();
272 final DeviceContext deviceCtx = this.deviceContexts.get(deviceInfo);
274 if (null == deviceCtx) {
275 LOG.info("DeviceContext for Node {} was not found. Connection is terminated without OFP context suite.", deviceInfo.getNodeId());
279 if (!connectionContext.equals(deviceCtx.getPrimaryConnectionContext())) {
280 /* Connection is not PrimaryConnection so try to remove from Auxiliary Connections */
281 deviceCtx.removeAuxiliaryConnectionContext(connectionContext);
283 notifyDeviceValidListeners(deviceInfo, false);
284 /* Device is disconnected and so we need to close TxManager */
285 final ListenableFuture<Void> future = deviceCtx.shuttingDownDataStoreTransactions();
286 Futures.addCallback(future, new FutureCallback<Void>() {
289 public void onSuccess(final Void result) {
290 LOG.debug("TxChainManager for device {} is closed successful.", deviceInfo.getNodeId());
291 deviceTerminPhaseHandler.onDeviceContextLevelDown(deviceInfo);
295 public void onFailure(final Throwable t) {
296 LOG.warn("TxChainManager for device {} failed by closing.", deviceInfo.getNodeId(), t);
297 deviceTerminPhaseHandler.onDeviceContextLevelDown(deviceInfo);
300 /* Add timer for Close TxManager because it could fain ind cluster without notification */
301 final TimerTask timerTask = timeout -> {
302 if (!future.isDone()) {
303 LOG.info("Shutting down TxChain for node {} not completed during 10 sec. Continue anyway.", deviceInfo.getNodeId());
304 future.cancel(false);
307 conductor.newTimeout(timerTask, 10, TimeUnit.SECONDS);
312 void addDeviceContextToMap(final DeviceInfo deviceInfo, final DeviceContext deviceContext){
313 deviceContexts.put(deviceInfo, deviceContext);
317 public <T extends OFPContext> T gainContext(final DeviceInfo deviceInfo) {
318 return (T) deviceContexts.get(deviceInfo);
322 public ListenableFuture<Void> onClusterRoleChange(final DeviceInfo deviceInfo, final OfpRole role) {
323 DeviceContext deviceContext = conductor.getDeviceContext(deviceInfo);
324 LOG.trace("onClusterRoleChange {} for node:", role, deviceInfo.getNodeId());
325 if (OfpRole.BECOMEMASTER.equals(role)) {
326 return onDeviceTakeClusterLeadership(deviceInfo);
328 return ((DeviceContextImpl)deviceContext).getTransactionChainManager().deactivateTransactionManager();
332 public void registerDeviceSynchronizeListeners(final DeviceSynchronizeListener deviceSynchronizeListener) {
333 this.deviceSynchronizedListeners.add(deviceSynchronizeListener);
337 public void notifyDeviceSynchronizeListeners(final DeviceInfo deviceInfo, final boolean deviceSynchronized) {
338 for (DeviceSynchronizeListener listener : deviceSynchronizedListeners) {
339 listener.deviceIsSynchronized(deviceInfo, deviceSynchronized);
344 public void registerDeviceValidListeners(final DeviceValidListener deviceValidListener) {
345 this.deviceValidListeners.add(deviceValidListener);
349 public void notifyDeviceValidListeners(final DeviceInfo deviceInfo, final boolean deviceValid) {
350 for (DeviceValidListener listener : deviceValidListeners) {
351 listener.deviceIsValid(deviceInfo, deviceValid);
355 private ListenableFuture<Void> onDeviceTakeClusterLeadership(final DeviceInfo deviceInfo) {
356 LOG.trace("onDeviceTakeClusterLeadership for node: {}", deviceInfo.getNodeId());
358 StatisticsContext statisticsContext = conductor.getStatisticsContext(deviceInfo);
359 if (statisticsContext == null) {
360 final String errMsg = String.format("DeviceCtx %s is up but we are missing StatisticsContext", deviceInfo.getDatapathId());
362 return Futures.immediateFailedFuture(new IllegalStateException(errMsg));
364 DeviceContext deviceContext = conductor.getDeviceContext(deviceInfo);
365 /* Prepare init info collecting */
366 notifyDeviceSynchronizeListeners(deviceInfo, false);
367 ((DeviceContextImpl)deviceContext).getTransactionChainManager().activateTransactionManager();
368 /* Init Collecting NodeInfo */
369 final ListenableFuture<Void> initCollectingDeviceInfo = DeviceInitializationUtils.initializeNodeInformation(
370 deviceContext, switchFeaturesMandatory);
371 /* Init Collecting StatInfo */
372 final ListenableFuture<Boolean> statPollFuture = Futures.transform(initCollectingDeviceInfo,
373 new AsyncFunction<Void, Boolean>() {
376 public ListenableFuture<Boolean> apply(@Nonnull final Void input) throws Exception {
377 statisticsContext.statListForCollectingInitialization();
378 return statisticsContext.gatherDynamicData();
382 return Futures.transform(statPollFuture, new Function<Boolean, Void>() {
385 public Void apply(final Boolean input) {
386 if (ConnectionContext.CONNECTION_STATE.RIP.equals(conductor.gainConnectionStateSafely(deviceInfo))) {
387 final String errMsg = String.format("We lost connection for Device %s, context has to be closed.",
388 deviceInfo.getNodeId());
390 throw new IllegalStateException(errMsg);
393 final String errMsg = String.format("Get Initial Device %s information fails",
394 deviceInfo.getNodeId());
396 throw new IllegalStateException(errMsg);
398 LOG.debug("Get Initial Device {} information is successful", deviceInfo.getNodeId());
399 notifyDeviceSynchronizeListeners(deviceInfo, true);
400 ((DeviceContextImpl)deviceContext).getTransactionChainManager().initialSubmitWriteTransaction();
401 deviceContext.getDeviceState().setStatisticsPollingEnabledProp(true);