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.util.concurrent.AsyncFunction;
15 import com.google.common.util.concurrent.FutureCallback;
16 import com.google.common.util.concurrent.Futures;
17 import com.google.common.util.concurrent.JdkFutureAdapters;
18 import com.google.common.util.concurrent.ListenableFuture;
19 import io.netty.util.HashedWheelTimer;
20 import io.netty.util.Timeout;
21 import io.netty.util.TimerTask;
22 import java.math.BigInteger;
23 import java.util.HashMap;
24 import java.util.List;
26 import java.util.concurrent.ExecutionException;
27 import java.util.concurrent.TimeUnit;
28 import java.util.concurrent.atomic.AtomicInteger;
29 import java.util.concurrent.Future;
30 import java.util.concurrent.TimeUnit;
31 import javax.annotation.Nonnull;
32 import javax.annotation.Nullable;
33 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
34 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
35 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
36 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
37 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainClosedException;
38 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
39 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
40 import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
41 import org.opendaylight.openflowplugin.api.OFConstants;
42 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
43 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
44 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
45 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
46 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
47 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
48 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
49 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
50 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
51 import org.opendaylight.openflowplugin.api.openflow.device.handlers.ClusterInitializationPhaseHandler;
52 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
53 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
54 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
55 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
56 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
57 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
58 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowDescriptor;
59 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowRegistryKey;
60 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
61 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
62 import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleKeeper;
63 import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
64 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
65 import org.opendaylight.openflowplugin.extension.api.ConvertorMessageFromOFJava;
66 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterProviderKeeper;
67 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
68 import org.opendaylight.openflowplugin.extension.api.exception.ConversionException;
69 import org.opendaylight.openflowplugin.extension.api.path.MessagePath;
70 import org.opendaylight.openflowplugin.impl.common.ItemLifeCycleSourceImpl;
71 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
72 import org.opendaylight.openflowplugin.impl.device.listener.MultiMsgCollectorImpl;
73 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
74 import org.opendaylight.openflowplugin.impl.registry.flow.FlowRegistryKeyFactory;
75 import org.opendaylight.openflowplugin.impl.registry.group.DeviceGroupRegistryImpl;
76 import org.opendaylight.openflowplugin.impl.registry.meter.DeviceMeterRegistryImpl;
77 import org.opendaylight.openflowplugin.impl.rpc.AbstractRequestContext;
78 import org.opendaylight.openflowplugin.impl.util.DeviceInitializationUtils;
79 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
80 import org.opendaylight.openflowplugin.openflow.md.core.session.SwitchConnectionCookieOFImpl;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.experimenter.message.service.rev151020.ExperimenterMessageFromDevBuilder;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortReason;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
99 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketIn;
100 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
101 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
102 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
103 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.experimenter.core.ExperimenterDataOfChoice;
104 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.experimenter.types.rev151020.experimenter.core.message.ExperimenterMessageOfChoice;
105 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SalRoleService;
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SetRoleInput;
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SetRoleInputBuilder;
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SetRoleOutput;
113 import org.opendaylight.yangtools.yang.binding.DataObject;
114 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
115 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
116 import org.opendaylight.yangtools.yang.common.RpcResult;
117 import org.slf4j.Logger;
118 import org.slf4j.LoggerFactory;
120 public class DeviceContextImpl implements DeviceContext, ExtensionConverterProviderKeeper {
122 private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
124 // TODO: drain factor should be parametrized
125 private static final float REJECTED_DRAIN_FACTOR = 0.25f;
126 // TODO: low water mark factor should be parametrized
127 private static final float LOW_WATERMARK_FACTOR = 0.75f;
128 // TODO: high water mark factor should be parametrized
129 private static final float HIGH_WATERMARK_FACTOR = 0.95f;
131 // Timeout in seconds after what we will give up on propagating role
132 private static final int SET_ROLE_TIMEOUT = 10;
134 private boolean initialized;
135 private static final Long RETRY_DELAY = 100L;
136 private static final int RETRY_COUNT = 3;
138 private SalRoleService salRoleService = null;
139 private final HashedWheelTimer hashedWheelTimer;
140 private ConnectionContext primaryConnectionContext;
141 private final DeviceState deviceState;
142 private final DataBroker dataBroker;
143 private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
144 private TransactionChainManager transactionChainManager;
145 private DeviceFlowRegistry deviceFlowRegistry;
146 private DeviceGroupRegistry deviceGroupRegistry;
147 private DeviceMeterRegistry deviceMeterRegistry;
148 private final PacketInRateLimiter packetInLimiter;
149 private final MessageSpy messageSpy;
150 private final ItemLifeCycleKeeper flowLifeCycleKeeper;
151 private NotificationPublishService notificationPublishService;
152 private Timeout barrierTaskTimeout;
153 private final MessageTranslator<PortGrouping, FlowCapableNodeConnector> portStatusTranslator;
154 private final MessageTranslator<PacketInMessage, PacketReceived> packetInTranslator;
155 private final MessageTranslator<FlowRemoved, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved> flowRemovedTranslator;
156 private final TranslatorLibrary translatorLibrary;
157 private final ItemLifeCycleRegistry itemLifeCycleSourceRegistry;
158 private ExtensionConverterProvider extensionConverterProvider;
159 private final DeviceManager deviceManager;
160 private boolean skipTableFeatures;
161 private boolean switchFeaturesMandatory;
162 private final DeviceInfo deviceInfo;
163 private final ConvertorExecutor convertorExecutor;
164 private volatile CONTEXT_STATE state;
165 private ClusterInitializationPhaseHandler clusterInitializationPhaseHandler;
166 private final DeviceManager myManager;
169 @Nonnull final ConnectionContext primaryConnectionContext,
170 @Nonnull final DataBroker dataBroker,
171 @Nonnull final MessageSpy messageSpy,
172 @Nonnull final TranslatorLibrary translatorLibrary,
173 @Nonnull final DeviceManager manager,
174 final ConvertorExecutor convertorExecutor,
175 final boolean skipTableFeatures,
176 final HashedWheelTimer hashedWheelTimer,
177 final DeviceManager myManager) {
178 this.primaryConnectionContext = primaryConnectionContext;
179 this.deviceInfo = primaryConnectionContext.getDeviceInfo();
180 this.hashedWheelTimer = hashedWheelTimer;
181 this.myManager = myManager;
182 this.deviceState = new DeviceStateImpl();
183 this.dataBroker = dataBroker;
184 this.auxiliaryConnectionContexts = new HashMap<>();
185 this.messageSpy = Preconditions.checkNotNull(messageSpy);
186 this.deviceManager = manager;
188 this.packetInLimiter = new PacketInRateLimiter(primaryConnectionContext.getConnectionAdapter(),
189 /*initial*/ 1000, /*initial*/2000, this.messageSpy, REJECTED_DRAIN_FACTOR);
191 this.translatorLibrary = translatorLibrary;
192 this.portStatusTranslator = translatorLibrary.lookupTranslator(
193 new TranslatorKey(deviceInfo.getVersion(), PortGrouping.class.getName()));
194 this.packetInTranslator = translatorLibrary.lookupTranslator(
195 new TranslatorKey(deviceInfo.getVersion(), PacketIn.class.getName()));
196 this.flowRemovedTranslator = translatorLibrary.lookupTranslator(
197 new TranslatorKey(deviceInfo.getVersion(), FlowRemoved.class.getName()));
199 this.itemLifeCycleSourceRegistry = new ItemLifeCycleRegistryImpl();
200 this.flowLifeCycleKeeper = new ItemLifeCycleSourceImpl();
201 this.itemLifeCycleSourceRegistry.registerLifeCycleSource(flowLifeCycleKeeper);
202 this.state = CONTEXT_STATE.INITIALIZATION;
203 this.convertorExecutor = convertorExecutor;
204 this.skipTableFeatures = skipTableFeatures;
205 this.initialized = false;
209 public void initialSubmitTransaction() {
211 transactionChainManager.initialSubmitWriteTransaction();
216 public void addAuxiliaryConnectionContext(final ConnectionContext connectionContext) {
217 final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
218 auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
221 private static SwitchConnectionDistinguisher createConnectionDistinguisher(final ConnectionContext connectionContext) {
222 return new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
226 public void removeAuxiliaryConnectionContext(final ConnectionContext connectionContext) {
227 final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
228 LOG.debug("auxiliary connection dropped: {}, nodeId:{}", connectionContext.getConnectionAdapter()
229 .getRemoteAddress(), getDeviceInfo().getLOGValue());
230 auxiliaryConnectionContexts.remove(connectionDistinguisher);
234 public DeviceState getDeviceState() {
239 public ReadOnlyTransaction getReadTransaction() {
240 return dataBroker.newReadOnlyTransaction();
244 public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
245 final InstanceIdentifier<T> path,
248 transactionChainManager.writeToTransaction(store, path, data, false);
253 public <T extends DataObject> void writeToTransactionWithParentsSlow(final LogicalDatastoreType store,
254 final InstanceIdentifier<T> path,
257 transactionChainManager.writeToTransaction(store, path, data, true);
262 public <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path) throws TransactionChainClosedException {
264 transactionChainManager.addDeleteOperationTotTxChain(store, path);
269 public boolean submitTransaction() {
270 return initialized && transactionChainManager.submitWriteTransaction();
274 public ConnectionContext getPrimaryConnectionContext() {
275 return primaryConnectionContext;
279 public ConnectionContext getAuxiliaryConnectionContexts(final BigInteger cookie) {
280 return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
284 public DeviceFlowRegistry getDeviceFlowRegistry() {
285 return deviceFlowRegistry;
289 public DeviceGroupRegistry getDeviceGroupRegistry() {
290 return deviceGroupRegistry;
294 public DeviceMeterRegistry getDeviceMeterRegistry() {
295 return deviceMeterRegistry;
299 public void processReply(final OfHeader ofHeader) {
300 if (ofHeader instanceof Error) {
301 messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
303 messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
308 public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
309 for (final MultipartReply multipartReply : ofHeaderList) {
310 messageSpy.spyMessage(multipartReply.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
315 public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
316 //1. translate to general flow (table, priority, match, cookie)
317 final org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved flowRemovedNotification =
318 flowRemovedTranslator.translate(flowRemoved, deviceInfo, null);
320 if(!deviceManager.getIsNotificationFlowRemovedOff()) {
321 // Trigger off a notification
322 notificationPublishService.offerNotification(flowRemovedNotification);
323 } else if(LOG.isDebugEnabled()) {
324 LOG.debug("For nodeId={} isNotificationFlowRemovedOff={}", getDeviceInfo().getLOGValue(), deviceManager.getIsNotificationFlowRemovedOff());
327 final ItemLifecycleListener itemLifecycleListener = flowLifeCycleKeeper.getItemLifecycleListener();
328 if (itemLifecycleListener != null) {
329 //2. create registry key
330 final FlowRegistryKey flowRegKey = FlowRegistryKeyFactory.create(flowRemovedNotification);
332 final FlowDescriptor flowDescriptor = deviceFlowRegistry.retrieveIdForFlow(flowRegKey);
333 //4. if flowId present:
334 if (flowDescriptor != null) {
335 // a) construct flow path
336 final KeyedInstanceIdentifier<Flow, FlowKey> flowPath = getDeviceInfo().getNodeInstanceIdentifier()
337 .augmentation(FlowCapableNode.class)
338 .child(Table.class, flowDescriptor.getTableKey())
339 .child(Flow.class, new FlowKey(flowDescriptor.getFlowId()));
340 // b) notify listener
341 itemLifecycleListener.onRemoved(flowPath);
343 LOG.debug("flow id not found: nodeId={} tableId={}, priority={}",
344 getDeviceInfo().getNodeId(), flowRegKey.getTableId(), flowRemovedNotification.getPriority());
350 public void processPortStatusMessage(final PortStatusMessage portStatus) {
351 messageSpy.spyMessage(portStatus.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
353 updatePortStatusMessage(portStatus);
354 } catch (final Exception e) {
355 LOG.warn("Error processing port status message for port {} on device {} : {}", portStatus.getPortNo().toString(),
356 getDeviceInfo().getNodeId().toString(), e);
357 retryProcessPortStatusMessage(portStatus,RETRY_COUNT);
361 private void retryProcessPortStatusMessage(final PortStatusMessage portStatus, final int retryCount){
362 Thread thread = new Thread(new PortStatusRetryRunnable(portStatus, retryCount));
366 private class PortStatusRetryRunnable implements Runnable {
367 private final PortStatusMessage portStatusMessage;
368 private final int retryCount;
371 PortStatusRetryRunnable (final PortStatusMessage portStatus,final int retry){
372 portStatusMessage = portStatus;
378 while(count < retryCount) {
380 TimeUnit.MILLISECONDS.sleep(RETRY_DELAY);
381 } catch (InterruptedException e) {
382 LOG.warn("Caught interrupted exception while sleeping during a port retry task");
386 updatePortStatusMessage(portStatusMessage);
388 } catch (final Exception e) {
389 LOG.warn("Error processing port status message for {} on port {} on device {} : {}",count,
390 portStatusMessage.getPortNo().toString(),getDeviceInfo().getNodeId().toString(), e);
394 LOG.warn("Failed to update port status for port {} on device {} even after 3 retries",
395 portStatusMessage.getPortNo().toString(),getDeviceInfo().getNodeId().toString());
399 void updatePortStatusMessage(final PortStatusMessage portStatusMessage){
400 final FlowCapableNodeConnector flowCapableNodeConnector = portStatusTranslator.translate(portStatusMessage,
401 getDeviceInfo(), null);
403 final KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> iiToNodeConnector =
404 provideIIToNodeConnector(portStatusMessage.getPortNo(), portStatusMessage.getVersion());
406 if (portStatusMessage.getReason().equals(PortReason.OFPPRADD) || portStatusMessage.getReason().
407 equals(PortReason.OFPPRMODIFY)) {
408 // because of ADD status node connector has to be created
409 final NodeConnectorBuilder nConnectorBuilder = new NodeConnectorBuilder().setKey(iiToNodeConnector.getKey());
410 nConnectorBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class,
411 new FlowCapableNodeConnectorStatisticsDataBuilder().build());
412 nConnectorBuilder.addAugmentation(FlowCapableNodeConnector.class, flowCapableNodeConnector);
413 writeToTransaction(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector, nConnectorBuilder.build());
414 } else if (portStatusMessage.getReason().equals(PortReason.OFPPRDELETE)) {
415 addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector);
420 private KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> provideIIToNodeConnector(final long portNo, final short version) {
421 final InstanceIdentifier<Node> iiToNodes = getDeviceInfo().getNodeInstanceIdentifier();
422 final BigInteger dataPathId = getDeviceInfo().getDatapathId();
423 final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), portNo, version);
424 return iiToNodes.child(NodeConnector.class, new NodeConnectorKey(nodeConnectorId));
428 public void processPacketInMessage(final PacketInMessage packetInMessage) {
429 messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH);
430 final ConnectionAdapter connectionAdapter = getPrimaryConnectionContext().getConnectionAdapter();
431 final PacketReceived packetReceived = packetInTranslator.translate(packetInMessage, getDeviceInfo(), null);
433 if (packetReceived == null) {
434 LOG.debug("Received a null packet from switch {}", connectionAdapter.getRemoteAddress());
435 messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_SRC_FAILURE);
438 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_OUT_SUCCESS);
441 if (!packetInLimiter.acquirePermit()) {
442 LOG.debug("Packet limited");
443 // TODO: save packet into emergency slot if possible
444 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PACKET_IN_LIMIT_REACHED_AND_DROPPED);
448 final ListenableFuture<?> offerNotification = notificationPublishService.offerNotification(packetReceived);
449 if (NotificationPublishService.REJECTED.equals(offerNotification)) {
450 LOG.debug("notification offer rejected");
451 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
452 packetInLimiter.drainLowWaterMark();
453 packetInLimiter.releasePermit();
457 Futures.addCallback(offerNotification, new FutureCallback<Object>() {
459 public void onSuccess(final Object result) {
460 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
461 packetInLimiter.releasePermit();
465 public void onFailure(final Throwable t) {
466 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
467 LOG.debug("notification offer failed: {}", t.getMessage());
468 LOG.trace("notification offer failed..", t);
469 packetInLimiter.releasePermit();
475 public void processExperimenterMessage(final ExperimenterMessage notification) {
477 final ExperimenterDataOfChoice vendorData = notification.getExperimenterDataOfChoice();
478 final MessageTypeKey<? extends ExperimenterDataOfChoice> key = new MessageTypeKey<>(
479 getDeviceInfo().getVersion(),
480 (Class<? extends ExperimenterDataOfChoice>) vendorData.getImplementedInterface());
481 final ConvertorMessageFromOFJava<ExperimenterDataOfChoice, MessagePath> messageConverter = extensionConverterProvider.getMessageConverter(key);
482 if (messageConverter == null) {
483 LOG.warn("custom converter for {}[OF:{}] not found",
484 notification.getExperimenterDataOfChoice().getImplementedInterface(),
485 getDeviceInfo().getVersion());
488 // build notification
489 final ExperimenterMessageOfChoice messageOfChoice;
491 messageOfChoice = messageConverter.convert(vendorData, MessagePath.MESSAGE_NOTIFICATION);
492 final ExperimenterMessageFromDevBuilder experimenterMessageFromDevBld = new ExperimenterMessageFromDevBuilder()
493 .setNode(new NodeRef(getDeviceInfo().getNodeInstanceIdentifier()))
494 .setExperimenterMessageOfChoice(messageOfChoice);
496 notificationPublishService.offerNotification(experimenterMessageFromDevBld.build());
497 } catch (final ConversionException e) {
498 LOG.error("Conversion of experimenter notification failed", e);
503 public TranslatorLibrary oook() {
504 return translatorLibrary;
508 public void setCurrentBarrierTimeout(final Timeout timeout) {
509 barrierTaskTimeout = timeout;
513 public Timeout getBarrierTaskTimeout() {
514 return barrierTaskTimeout;
518 public void setNotificationPublishService(final NotificationPublishService notificationPublishService) {
519 this.notificationPublishService = notificationPublishService;
523 public MessageSpy getMessageSpy() {
528 public void onPublished() {
529 Verify.verify(CONTEXT_STATE.INITIALIZATION.equals(getState()));
530 this.state = CONTEXT_STATE.WORKING;
531 primaryConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
532 for (final ConnectionContext switchAuxConnectionContext : auxiliaryConnectionContexts.values()) {
533 switchAuxConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
538 public MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext) {
539 return new MultiMsgCollectorImpl(this, requestContext);
543 public void updatePacketInRateLimit(final long upperBound) {
544 packetInLimiter.changeWaterMarks((int) (LOW_WATERMARK_FACTOR * upperBound), (int) (HIGH_WATERMARK_FACTOR * upperBound));
548 public ItemLifeCycleRegistry getItemLifeCycleSourceRegistry() {
549 return itemLifeCycleSourceRegistry;
553 public void setExtensionConverterProvider(final ExtensionConverterProvider extensionConverterProvider) {
554 this.extensionConverterProvider = extensionConverterProvider;
558 public ExtensionConverterProvider getExtensionConverterProvider() {
559 return extensionConverterProvider;
563 public synchronized void shutdownConnection() {
564 if (LOG.isDebugEnabled()) {
565 LOG.debug("Shutdown method for node {}", getDeviceInfo().getLOGValue());
567 if (CONTEXT_STATE.TERMINATION.equals(getState())) {
568 LOG.debug("DeviceCtx for Node {} is in termination process.", getDeviceInfo().getLOGValue());
572 if (ConnectionContext.CONNECTION_STATE.RIP.equals(getPrimaryConnectionContext().getConnectionState())) {
573 LOG.debug("ConnectionCtx for Node {} is in RIP state.", getDeviceInfo().getLOGValue());
577 // Terminate Auxiliary Connection
578 for (final ConnectionContext connectionContext : auxiliaryConnectionContexts.values()) {
579 LOG.debug("Closing auxiliary connection {}", connectionContext.getNodeId());
580 connectionContext.closeConnection(false);
583 // Terminate Primary Connection
584 getPrimaryConnectionContext().closeConnection(true);
586 // Close all datastore registries
588 deviceGroupRegistry.close();
589 deviceFlowRegistry.close();
590 deviceMeterRegistry.close();
595 public ListenableFuture<Void> shuttingDownDataStoreTransactions() {
597 ? this.transactionChainManager.shuttingDown()
598 : Futures.immediateFuture(null);
602 TransactionChainManager getTransactionChainManager() {
603 return this.transactionChainManager;
607 public void setSwitchFeaturesMandatory(boolean switchFeaturesMandatory) {
608 this.switchFeaturesMandatory = switchFeaturesMandatory;
612 public CONTEXT_STATE getState() {
617 public ListenableFuture<Void> stopClusterServices(boolean connectionInterrupted) {
618 final ListenableFuture<Void> deactivateTxManagerFuture = initialized
619 ? transactionChainManager.deactivateTransactionManager()
620 : Futures.immediateFuture(null);
622 if (!connectionInterrupted) {
623 final ListenableFuture<Void> makeSlaveFuture = Futures.transform(makeDeviceSlave(), new Function<RpcResult<SetRoleOutput>, Void>() {
626 public Void apply(@Nullable RpcResult<SetRoleOutput> setRoleOutputRpcResult) {
631 Futures.addCallback(makeSlaveFuture, new FutureCallback<Void>() {
633 public void onSuccess(@Nullable Void aVoid) {
634 if (LOG.isDebugEnabled()) {
635 LOG.debug("Role SLAVE was successfully propagated on device, node {}", deviceInfo.getLOGValue());
640 public void onFailure(final Throwable throwable) {
641 LOG.warn("Was not able to set role SLAVE to device on node {} ", deviceInfo.getLOGValue());
642 LOG.trace("Error occurred on device role setting, probably connection loss: ", throwable);
646 return Futures.transform(deactivateTxManagerFuture, new AsyncFunction<Void, Void>() {
648 public ListenableFuture<Void> apply(Void aVoid) throws Exception {
649 // Add fallback to remove device from operational DS if setting slave fails
650 return Futures.withFallback(makeSlaveFuture, t ->
651 myManager.removeDeviceFromOperationalDS(deviceInfo));
655 return Futures.transform(deactivateTxManagerFuture, new AsyncFunction<Void, Void>() {
657 public ListenableFuture<Void> apply(Void aVoid) throws Exception {
658 return myManager.removeDeviceFromOperationalDS(deviceInfo);
665 public ServiceGroupIdentifier getServiceIdentifier() {
666 return this.deviceInfo.getServiceIdentifier();
670 public DeviceInfo getDeviceInfo() {
671 return this.deviceInfo;
675 public void close() {
676 if (CONTEXT_STATE.TERMINATION.equals(getState())){
677 if (LOG.isDebugEnabled()) {
678 LOG.debug("DeviceContext for node {} is already in TERMINATION state.", getDeviceInfo().getLOGValue());
681 this.state = CONTEXT_STATE.TERMINATION;
686 public void putLifecycleServiceIntoTxChainManager(final LifecycleService lifecycleService){
688 this.transactionChainManager.setLifecycleService(lifecycleService);
693 public void replaceConnectionContext(final ConnectionContext connectionContext){
694 // Act like we are initializing the context
695 this.state = CONTEXT_STATE.INITIALIZATION;
696 this.primaryConnectionContext = connectionContext;
701 public boolean isSkipTableFeatures() {
702 return this.skipTableFeatures;
706 public void setSalRoleService(@Nonnull SalRoleService salRoleService) {
707 this.salRoleService = salRoleService;
711 public void setLifecycleInitializationPhaseHandler(final ClusterInitializationPhaseHandler handler) {
712 this.clusterInitializationPhaseHandler = handler;
716 public boolean onContextInstantiateService(final ConnectionContext connectionContext) {
718 if (getPrimaryConnectionContext().getConnectionState().equals(ConnectionContext.CONNECTION_STATE.RIP)) {
719 LOG.warn("Connection on device {} was interrupted, will stop starting master services.", deviceInfo.getLOGValue());
723 LOG.info("Starting device context cluster services for node {}", deviceInfo.getLOGValue());
725 lazyTransactionManagerInitialization();
727 this.transactionChainManager.activateTransactionManager();
730 DeviceInitializationUtils.initializeNodeInformation(this, switchFeaturesMandatory, this.convertorExecutor);
731 } catch (ExecutionException | InterruptedException e) {
732 LOG.warn("Device {} cannot be initialized: ", deviceInfo.getLOGValue(), e);
736 Futures.addCallback(sendRoleChangeToDevice(OfpRole.BECOMEMASTER), new RpcResultFutureCallback());
738 return this.clusterInitializationPhaseHandler.onContextInstantiateService(getPrimaryConnectionContext());
742 void lazyTransactionManagerInitialization() {
743 if (!this.initialized) {
744 if (LOG.isDebugEnabled()) {
745 LOG.debug("Transaction chain manager for node {} created", deviceInfo.getLOGValue());
747 this.transactionChainManager = new TransactionChainManager(dataBroker, deviceInfo);
748 this.deviceFlowRegistry = new DeviceFlowRegistryImpl(dataBroker, deviceInfo.getNodeInstanceIdentifier());
749 this.deviceGroupRegistry = new DeviceGroupRegistryImpl();
750 this.deviceMeterRegistry = new DeviceMeterRegistryImpl();
751 this.initialized = true;
757 public <T> RequestContext<T> createRequestContext() {
758 return new AbstractRequestContext<T>(deviceInfo.reserveXidForDeviceMessage()) {
760 public void close() {
766 ListenableFuture<RpcResult<SetRoleOutput>> sendRoleChangeToDevice(final OfpRole newRole) {
767 if (LOG.isDebugEnabled()) {
768 LOG.debug("Sending new role {} to device {}", newRole, deviceInfo.getNodeId());
771 final Future<RpcResult<SetRoleOutput>> setRoleOutputFuture;
773 if (deviceInfo.getVersion() >= OFConstants.OFP_VERSION_1_3) {
774 final SetRoleInput setRoleInput = (new SetRoleInputBuilder()).setControllerRole(newRole)
775 .setNode(new NodeRef(deviceInfo.getNodeInstanceIdentifier())).build();
777 setRoleOutputFuture = this.salRoleService.setRole(setRoleInput);
779 final TimerTask timerTask = timeout -> {
780 if (!setRoleOutputFuture.isDone()) {
781 LOG.warn("New role {} was not propagated to device {} during {} sec", newRole, deviceInfo.getLOGValue(), SET_ROLE_TIMEOUT);
782 setRoleOutputFuture.cancel(true);
786 hashedWheelTimer.newTimeout(timerTask, SET_ROLE_TIMEOUT, TimeUnit.SECONDS);
788 LOG.info("Device: {} with version: {} does not support role", deviceInfo.getLOGValue(), deviceInfo.getVersion());
789 return Futures.immediateFuture(null);
792 return JdkFutureAdapters.listenInPoolThread(setRoleOutputFuture);
796 public ListenableFuture<RpcResult<SetRoleOutput>> makeDeviceSlave() {
797 return sendRoleChangeToDevice(OfpRole.BECOMESLAVE);
800 private class RpcResultFutureCallback implements FutureCallback<RpcResult<SetRoleOutput>> {
802 public void onSuccess(@Nullable RpcResult<SetRoleOutput> setRoleOutputRpcResult) {
803 if (LOG.isDebugEnabled()) {
804 LOG.debug("Role MASTER was successfully set on device, node {}", deviceInfo.getLOGValue());
809 public void onFailure(final Throwable throwable) {
810 LOG.warn("Was not able to set MASTER role on device, node {}", deviceInfo.getLOGValue());
811 shutdownConnection();