-/**
- * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
+/*
+ * Copyright (c) 2015, 2017 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
*/
package org.opendaylight.openflowplugin.impl.device;
-import com.google.common.annotations.VisibleForTesting;
-import com.google.common.base.Preconditions;
-import com.google.common.collect.Iterators;
-import com.google.common.util.concurrent.FutureCallback;
-import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import io.netty.util.HashedWheelTimer;
-import io.netty.util.TimerTask;
-import java.util.Collections;
-import java.util.Iterator;
-import java.util.Objects;
+import java.util.Optional;
+import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
-import java.util.concurrent.ExecutionException;
import java.util.concurrent.ScheduledThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
-import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
-import org.opendaylight.controller.md.sal.binding.api.DataBroker;
-import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
-import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
-import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
-import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
-import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
+import org.opendaylight.mdsal.binding.api.DataBroker;
+import org.opendaylight.mdsal.binding.api.NotificationPublishService;
+import org.opendaylight.mdsal.binding.api.WriteTransaction;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueueHandlerRegistration;
import org.opendaylight.openflowplugin.api.openflow.OFPContext;
import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
-import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionStatus;
import org.opendaylight.openflowplugin.api.openflow.connection.OutboundQueueProvider;
import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
-import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
+import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChainHolder;
import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
import org.opendaylight.openflowplugin.extension.api.ExtensionConverterProviderKeeper;
import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
import org.opendaylight.openflowplugin.impl.connection.OutboundQueueProviderImpl;
+import org.opendaylight.openflowplugin.impl.device.initialization.DeviceInitializerProvider;
import org.opendaylight.openflowplugin.impl.device.listener.OpenflowProtocolListenerFullImpl;
-import org.opendaylight.openflowplugin.impl.lifecycle.LifecycleServiceImpl;
+import org.opendaylight.openflowplugin.impl.util.DeviceInitializationUtil;
import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRemovedBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeUpdatedBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
-import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.OpenflowProviderConfig;
+import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- *
- */
public class DeviceManagerImpl implements DeviceManager, ExtensionConverterProviderKeeper {
private static final Logger LOG = LoggerFactory.getLogger(DeviceManagerImpl.class);
-
- private final long globalNotificationQuota;
- private final boolean switchFeaturesMandatory;
- private boolean isNotificationFlowRemovedOff;
- private boolean skipTableFeatures;
private static final int SPY_RATE = 10;
+ private final OpenflowProviderConfig config;
private final DataBroker dataBroker;
+ private final DeviceInitializerProvider deviceInitializerProvider;
private final ConvertorExecutor convertorExecutor;
- private TranslatorLibrary translatorLibrary;
- private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
- private DeviceTerminationPhaseHandler deviceTerminPhaseHandler;
-
private final ConcurrentMap<DeviceInfo, DeviceContext> deviceContexts = new ConcurrentHashMap<>();
- private final ConcurrentMap<DeviceInfo, LifecycleService> lifecycleServices = new ConcurrentHashMap<>();
-
- private final long barrierIntervalNanos;
- private final int barrierCountLimit;
-
- private ExtensionConverterProvider extensionConverterProvider;
- private ScheduledThreadPoolExecutor spyPool;
- private final ClusterSingletonServiceProvider singletonServiceProvider;
+ private final Set<KeyedInstanceIdentifier<Node, NodeKey>> notificationCreateNodeSend =
+ ConcurrentHashMap.newKeySet();
private final NotificationPublishService notificationPublishService;
private final MessageSpy messageSpy;
private final HashedWheelTimer hashedWheelTimer;
-
- public DeviceManagerImpl(@Nonnull final DataBroker dataBroker,
- final long globalNotificationQuota,
- final boolean switchFeaturesMandatory,
- final long barrierInterval,
- final int barrierCountLimit,
- final MessageSpy messageSpy,
- final boolean isNotificationFlowRemovedOff,
- final ClusterSingletonServiceProvider singletonServiceProvider,
- final NotificationPublishService notificationPublishService,
- final HashedWheelTimer hashedWheelTimer,
- final ConvertorExecutor convertorExecutor,
- final boolean skipTableFeatures) {
-
- this.switchFeaturesMandatory = switchFeaturesMandatory;
- this.globalNotificationQuota = globalNotificationQuota;
- this.isNotificationFlowRemovedOff = isNotificationFlowRemovedOff;
- this.skipTableFeatures = skipTableFeatures;
- this.dataBroker = Preconditions.checkNotNull(dataBroker);
+ private final Object updatePacketInRateLimitersLock = new Object();
+ private TranslatorLibrary translatorLibrary;
+ private ExtensionConverterProvider extensionConverterProvider;
+ private ScheduledThreadPoolExecutor spyPool;
+ private ContextChainHolder contextChainHolder;
+
+ public DeviceManagerImpl(@Nonnull final OpenflowProviderConfig config,
+ @Nonnull final DataBroker dataBroker,
+ @Nonnull final MessageSpy messageSpy,
+ @Nonnull final NotificationPublishService notificationPublishService,
+ @Nonnull final HashedWheelTimer hashedWheelTimer,
+ @Nonnull final ConvertorExecutor convertorExecutor,
+ @Nonnull final DeviceInitializerProvider deviceInitializerProvider) {
+ this.config = config;
+ this.dataBroker = dataBroker;
+ this.deviceInitializerProvider = deviceInitializerProvider;
this.convertorExecutor = convertorExecutor;
this.hashedWheelTimer = hashedWheelTimer;
- /* merge empty nodes to oper DS to predict any problems with missing parent for Node */
- final WriteTransaction tx = dataBroker.newWriteOnlyTransaction();
-
- final NodesBuilder nodesBuilder = new NodesBuilder();
- nodesBuilder.setNode(Collections.<Node>emptyList());
- tx.merge(LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.create(Nodes.class), nodesBuilder.build());
- try {
- tx.submit().get();
- } catch (ExecutionException | InterruptedException e) {
- LOG.error("Creation of node failed.", e);
- throw new IllegalStateException(e);
- }
-
- this.barrierIntervalNanos = TimeUnit.MILLISECONDS.toNanos(barrierInterval);
- this.barrierCountLimit = barrierCountLimit;
-
- spyPool = new ScheduledThreadPoolExecutor(1);
- this.singletonServiceProvider = singletonServiceProvider;
+ this.spyPool = new ScheduledThreadPoolExecutor(1);
this.notificationPublishService = notificationPublishService;
this.messageSpy = messageSpy;
+ DeviceInitializationUtil.makeEmptyNodes(dataBroker);
}
+ @Override
+ public TranslatorLibrary oook() {
+ return translatorLibrary;
+ }
@Override
- public void setDeviceInitializationPhaseHandler(final DeviceInitializationPhaseHandler handler) {
- this.deviceInitPhaseHandler = handler;
+ public void setTranslatorLibrary(final TranslatorLibrary translatorLibrary) {
+ this.translatorLibrary = translatorLibrary;
}
@Override
- public void onDeviceContextLevelUp(@CheckForNull DeviceInfo deviceInfo, final LifecycleService lifecycleService) throws Exception {
- // final phase - we have to add new Device to MD-SAL DataStore
- LOG.debug("Final phase of DeviceContextLevelUp for Node: {} ", deviceInfo.getNodeId());
- DeviceContext deviceContext = Preconditions.checkNotNull(deviceContexts.get(deviceInfo));
- deviceContext.onPublished();
- lifecycleService.registerService(this.singletonServiceProvider);
+ public void close() {
+ deviceContexts.values().forEach(OFPContext::close);
+ deviceContexts.clear();
+ Optional.ofNullable(spyPool).ifPresent(ScheduledThreadPoolExecutor::shutdownNow);
+ spyPool = null;
+
}
@Override
- public ConnectionStatus deviceConnected(@CheckForNull final ConnectionContext connectionContext) throws Exception {
- Preconditions.checkArgument(connectionContext != null);
-
- DeviceInfo deviceInfo = connectionContext.getDeviceInfo();
- /*
- * This part prevent destroy another device context. Throwing here an exception result to propagate close connection
- * in {@link org.opendaylight.openflowplugin.impl.connection.org.opendaylight.openflowplugin.impl.connection.HandshakeContextImpl}
- * If context already exist we are in state closing process (connection flapping) and we should not propagate connection close
- */
- if (deviceContexts.containsKey(deviceInfo)) {
- DeviceContext deviceContext = deviceContexts.get(deviceInfo);
- LOG.warn("Node {} already connected disconnecting device. Rejecting connection", deviceInfo);
- if (!deviceContext.getState().equals(OFPContext.CONTEXT_STATE.TERMINATION)) {
- LOG.warn("Node {} context state not in TERMINATION state.",
- connectionContext.getDeviceInfo().getLOGValue());
- return ConnectionStatus.ALREADY_CONNECTED;
- } else {
- return ConnectionStatus.CLOSING;
- }
- }
+ public void initialize() {
+ spyPool.scheduleAtFixedRate(messageSpy, SPY_RATE, SPY_RATE, TimeUnit.SECONDS);
+ }
- LOG.info("ConnectionEvent: Device connected to controller, Device:{}, NodeId:{}",
- connectionContext.getConnectionAdapter().getRemoteAddress(), deviceInfo.getNodeId());
+ @Override
+ public void setExtensionConverterProvider(final ExtensionConverterProvider extensionConverterProvider) {
+ this.extensionConverterProvider = extensionConverterProvider;
+ }
+
+ @Override
+ public ExtensionConverterProvider getExtensionConverterProvider() {
+ return extensionConverterProvider;
+ }
+
+ @Override
+ public ListenableFuture<?> removeDeviceFromOperationalDS(@Nonnull final KeyedInstanceIdentifier<Node, NodeKey> ii) {
+
+ final WriteTransaction delWtx = dataBroker.newWriteOnlyTransaction();
+ delWtx.delete(LogicalDatastoreType.OPERATIONAL, ii);
+ return delWtx.commit();
+
+ }
+
+ @Override
+ public DeviceContext createContext(@Nonnull final ConnectionContext connectionContext) {
- // Add Disconnect handler
- connectionContext.setDeviceDisconnectedHandler(DeviceManagerImpl.this);
- // Cache this for clarity
- final ConnectionAdapter connectionAdapter = connectionContext.getConnectionAdapter();
+ LOG.info("ConnectionEvent: Device connected to controller, Device:{}, NodeId:{}",
+ connectionContext.getConnectionAdapter().getRemoteAddress(),
+ connectionContext.getDeviceInfo().getNodeId());
- //FIXME: as soon as auxiliary connection are fully supported then this is needed only before device context published
- connectionAdapter.setPacketInFiltering(true);
+ connectionContext.getConnectionAdapter().setPacketInFiltering(true);
- final OutboundQueueProvider outboundQueueProvider = new OutboundQueueProviderImpl(deviceInfo.getVersion());
+ final OutboundQueueProvider outboundQueueProvider
+ = new OutboundQueueProviderImpl(connectionContext.getDeviceInfo().getVersion());
connectionContext.setOutboundQueueProvider(outboundQueueProvider);
final OutboundQueueHandlerRegistration<OutboundQueueProvider> outboundQueueHandlerRegistration =
- connectionAdapter.registerOutboundQueueHandler(outboundQueueProvider, barrierCountLimit, barrierIntervalNanos);
+ connectionContext.getConnectionAdapter().registerOutboundQueueHandler(
+ outboundQueueProvider,
+ config.getBarrierCountLimit().getValue(),
+ TimeUnit.MILLISECONDS.toNanos(config.getBarrierIntervalTimeoutLimit().getValue()));
connectionContext.setOutboundQueueHandleRegistration(outboundQueueHandlerRegistration);
+
final DeviceContext deviceContext = new DeviceContextImpl(
connectionContext,
dataBroker,
messageSpy,
translatorLibrary,
- this,
convertorExecutor,
- skipTableFeatures);
-
- deviceContexts.putIfAbsent(deviceInfo, deviceContext);
-
- final LifecycleService lifecycleService = new LifecycleServiceImpl();
- lifecycleService.setDeviceContext(deviceContext);
- deviceContext.putLifecycleServiceIntoTxChainManager(lifecycleService);
-
- lifecycleServices.putIfAbsent(deviceInfo, lifecycleService);
-
- deviceContext.setSwitchFeaturesMandatory(switchFeaturesMandatory);
+ config.isSkipTableFeatures(),
+ hashedWheelTimer,
+ config.isUseSingleLayerSerialization(),
+ deviceInitializerProvider,
+ config.isEnableFlowRemovedNotification(),
+ config.isSwitchFeaturesMandatory(),
+ contextChainHolder);
((ExtensionConverterProviderKeeper) deviceContext).setExtensionConverterProvider(extensionConverterProvider);
deviceContext.setNotificationPublishService(notificationPublishService);
+ deviceContexts.put(connectionContext.getDeviceInfo(), deviceContext);
updatePacketInRateLimiters();
final OpenflowProtocolListenerFullImpl messageListener = new OpenflowProtocolListenerFullImpl(
- connectionAdapter, deviceContext);
+ connectionContext.getConnectionAdapter(), deviceContext);
- connectionAdapter.setMessageListener(messageListener);
- deviceInitPhaseHandler.onDeviceContextLevelUp(connectionContext.getDeviceInfo(), lifecycleService);
- return ConnectionStatus.MAY_CONTINUE;
+ connectionContext.getConnectionAdapter().setMessageListener(messageListener);
+ connectionContext.getConnectionAdapter().setAlienMessageListener(messageListener);
+
+ return deviceContext;
}
private void updatePacketInRateLimiters() {
- synchronized (deviceContexts) {
+ synchronized (updatePacketInRateLimitersLock) {
final int deviceContextsSize = deviceContexts.size();
if (deviceContextsSize > 0) {
- long freshNotificationLimit = globalNotificationQuota / deviceContextsSize;
+ long freshNotificationLimit = config.getGlobalNotificationQuota() / deviceContextsSize;
if (freshNotificationLimit < 100) {
freshNotificationLimit = 100;
}
- LOG.debug("fresh notification limit = {}", freshNotificationLimit);
+ if (LOG.isDebugEnabled()) {
+ LOG.debug("fresh notification limit = {}", freshNotificationLimit);
+ }
for (final DeviceContext deviceContext : deviceContexts.values()) {
deviceContext.updatePacketInRateLimit(freshNotificationLimit);
}
}
@Override
- public TranslatorLibrary oook() {
- return translatorLibrary;
- }
-
- @Override
- public void setTranslatorLibrary(final TranslatorLibrary translatorLibrary) {
- this.translatorLibrary = translatorLibrary;
- }
-
- @Override
- public void close() {
- for (final Iterator<DeviceContext> iterator = Iterators.consumingIterator(deviceContexts.values().iterator());
- iterator.hasNext();) {
- final DeviceContext deviceCtx = iterator.next();
- deviceCtx.shutdownConnection();
- deviceCtx.shuttingDownDataStoreTransactions();
- }
-
- if (spyPool != null) {
- spyPool.shutdownNow();
- spyPool = null;
- }
- }
-
- @Override
- public void onDeviceContextLevelDown(final DeviceInfo deviceInfo) {
-
- LifecycleService lifecycleService = lifecycleServices.remove(deviceInfo);
- if (LOG.isDebugEnabled()) {
- LOG.debug("Lifecycle service removed for node {}", deviceInfo.getLOGValue());
- }
-
- updatePacketInRateLimiters();
- if (Objects.nonNull(lifecycleService)) {
- try {
- lifecycleService.close();
- LOG.debug("Lifecycle service successfully closed for node {}", deviceInfo.getLOGValue());
- } catch (Exception e) {
- LOG.warn("Closing lifecycle service for node {} was unsuccessful ", deviceInfo.getLOGValue(), e);
- }
- }
-
+ public void onDeviceRemoved(final DeviceInfo deviceInfo) {
deviceContexts.remove(deviceInfo);
if (LOG.isDebugEnabled()) {
- LOG.debug("Device context removed for node {}", deviceInfo.getLOGValue());
+ LOG.debug("Device context removed for node {}", deviceInfo);
}
+ this.updatePacketInRateLimiters();
}
@Override
- public void initialize() {
- spyPool.scheduleAtFixedRate(messageSpy, SPY_RATE, SPY_RATE, TimeUnit.SECONDS);
- }
-
- @Override
- public void setExtensionConverterProvider(final ExtensionConverterProvider extensionConverterProvider) {
- this.extensionConverterProvider = extensionConverterProvider;
- }
-
- @Override
- public ExtensionConverterProvider getExtensionConverterProvider() {
- return extensionConverterProvider;
- }
-
- @Override
- public void setDeviceTerminationPhaseHandler(final DeviceTerminationPhaseHandler handler) {
- this.deviceTerminPhaseHandler = handler;
- }
-
- @Override
- public void onDeviceDisconnected(final ConnectionContext connectionContext) {
- LOG.trace("onDeviceDisconnected method call for Node: {}", connectionContext.getNodeId());
- final DeviceInfo deviceInfo = connectionContext.getDeviceInfo();
- final DeviceContext deviceCtx = this.deviceContexts.get(deviceInfo);
-
- if (null == deviceCtx) {
- LOG.info("DeviceContext for Node {} was not found. Connection is terminated without OFP context suite.", deviceInfo.getLOGValue());
- return;
- }
-
- if (deviceCtx.getState().equals(OFPContext.CONTEXT_STATE.TERMINATION)) {
- LOG.debug("Device context for node {} is already is termination state, waiting for close all context");
- return;
- }
-
- deviceCtx.setState(OFPContext.CONTEXT_STATE.TERMINATION);
-
- if (!connectionContext.equals(deviceCtx.getPrimaryConnectionContext())) {
- LOG.debug("Node {} disconnected, but not primary connection.", connectionContext.getDeviceInfo().getLOGValue());
- /* Connection is not PrimaryConnection so try to remove from Auxiliary Connections */
- deviceCtx.removeAuxiliaryConnectionContext(connectionContext);
+ public void sendNodeRemovedNotification(@Nonnull final KeyedInstanceIdentifier<Node, NodeKey> instanceIdentifier) {
+ if (notificationCreateNodeSend.remove(instanceIdentifier)) {
+ NodeRemovedBuilder builder = new NodeRemovedBuilder();
+ builder.setNodeRef(new NodeRef(instanceIdentifier));
+ LOG.info("Publishing node removed notification for {}", instanceIdentifier.firstKeyOf(Node.class).getId());
+ notificationPublishService.offerNotification(builder.build());
}
- //TODO: Auxiliary connections supported ?
- {
- /* Device is disconnected and so we need to close TxManager */
- final ListenableFuture<Void> future = deviceCtx.shuttingDownDataStoreTransactions();
- Futures.addCallback(future, new FutureCallback<Void>() {
-
- @Override
- public void onSuccess(final Void result) {
- LOG.debug("TxChainManager for device {} is closed successful.", deviceInfo.getLOGValue());
- deviceTerminPhaseHandler.onDeviceContextLevelDown(deviceInfo);
- }
-
- @Override
- public void onFailure(final Throwable t) {
- LOG.warn("TxChainManager for device {} failed by closing.", deviceInfo.getLOGValue());
- LOG.trace("TxChainManager failed by closing. ", t);
- deviceTerminPhaseHandler.onDeviceContextLevelDown(deviceInfo);
- }
- });
- /* Add timer for Close TxManager because it could fain ind cluster without notification */
- final TimerTask timerTask = timeout -> {
- if (!future.isDone()) {
- LOG.warn("Shutting down TxChain for node {} not completed during 10 sec. Continue anyway.", deviceInfo.getLOGValue());
- future.cancel(false);
- }
- };
- hashedWheelTimer.newTimeout(timerTask, 10, TimeUnit.SECONDS);
- }
- }
-
- @VisibleForTesting
- void addDeviceContextToMap(final DeviceInfo deviceInfo, final DeviceContext deviceContext){
- deviceContexts.put(deviceInfo, deviceContext);
}
@Override
- public void setIsNotificationFlowRemovedOff(boolean isNotificationFlowRemovedOff) {
- this.isNotificationFlowRemovedOff = isNotificationFlowRemovedOff;
+ public void setContextChainHolder(@Nonnull ContextChainHolder contextChainHolder) {
+ this.contextChainHolder = contextChainHolder;
}
@Override
- public boolean getIsNotificationFlowRemovedOff() {
- return this.isNotificationFlowRemovedOff;
- }
-
-
- @Override
- public void setSkipTableFeatures(boolean skipTableFeaturesValue) {
- skipTableFeatures = skipTableFeaturesValue;
+ public void sendNodeAddedNotification(@Nonnull final KeyedInstanceIdentifier<Node, NodeKey> instanceIdentifier) {
+ if (!notificationCreateNodeSend.contains(instanceIdentifier)) {
+ notificationCreateNodeSend.add(instanceIdentifier);
+ final NodeId id = instanceIdentifier.firstKeyOf(Node.class).getId();
+ NodeUpdatedBuilder builder = new NodeUpdatedBuilder();
+ builder.setId(id);
+ builder.setNodeRef(new NodeRef(instanceIdentifier));
+ LOG.info("Publishing node added notification for {}", id);
+ notificationPublishService.offerNotification(builder.build());
+ }
}
-
}
Code Review / openflowplugin.git / blobdiff