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.Future;
28 import java.util.concurrent.TimeUnit;
29 import javax.annotation.Nonnull;
30 import javax.annotation.Nullable;
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.ReadOnlyTransaction;
34 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
35 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
36 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
37 import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
38 import org.opendaylight.openflowplugin.api.OFConstants;
39 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
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.MessageTranslator;
45 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
46 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
47 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
48 import org.opendaylight.openflowplugin.api.openflow.device.handlers.ClusterInitializationPhaseHandler;
49 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
50 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
51 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
52 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
53 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
54 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
55 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowDescriptor;
56 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowRegistryKey;
57 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
58 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
59 import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleKeeper;
60 import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
61 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
62 import org.opendaylight.openflowplugin.extension.api.ConvertorMessageFromOFJava;
63 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterProviderKeeper;
64 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
65 import org.opendaylight.openflowplugin.extension.api.exception.ConversionException;
66 import org.opendaylight.openflowplugin.extension.api.path.MessagePath;
67 import org.opendaylight.openflowplugin.impl.common.ItemLifeCycleSourceImpl;
68 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
69 import org.opendaylight.openflowplugin.impl.device.listener.MultiMsgCollectorImpl;
70 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
71 import org.opendaylight.openflowplugin.impl.registry.flow.FlowRegistryKeyFactory;
72 import org.opendaylight.openflowplugin.impl.registry.group.DeviceGroupRegistryImpl;
73 import org.opendaylight.openflowplugin.impl.registry.meter.DeviceMeterRegistryImpl;
74 import org.opendaylight.openflowplugin.impl.rpc.AbstractRequestContext;
75 import org.opendaylight.openflowplugin.impl.util.DeviceInitializationUtils;
76 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
77 import org.opendaylight.openflowplugin.openflow.md.core.session.SwitchConnectionCookieOFImpl;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.experimenter.message.service.rev151020.ExperimenterMessageFromDevBuilder;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortReason;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketIn;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
99 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
100 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.experimenter.core.ExperimenterDataOfChoice;
101 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.experimenter.types.rev151020.experimenter.core.message.ExperimenterMessageOfChoice;
102 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
103 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
104 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
105 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SalRoleService;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SetRoleInput;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SetRoleInputBuilder;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SetRoleOutput;
110 import org.opendaylight.yangtools.yang.binding.DataObject;
111 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
112 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
113 import org.opendaylight.yangtools.yang.common.RpcResult;
114 import org.slf4j.Logger;
115 import org.slf4j.LoggerFactory;
117 public class DeviceContextImpl implements DeviceContext, ExtensionConverterProviderKeeper{
119 private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
121 // TODO: drain factor should be parametrized
122 private static final float REJECTED_DRAIN_FACTOR = 0.25f;
123 // TODO: low water mark factor should be parametrized
124 private static final float LOW_WATERMARK_FACTOR = 0.75f;
125 // TODO: high water mark factor should be parametrized
126 private static final float HIGH_WATERMARK_FACTOR = 0.95f;
128 // Timeout in seconds after what we will give up on propagating role
129 private static final int SET_ROLE_TIMEOUT = 10;
131 private boolean initialized;
133 private SalRoleService salRoleService = null;
134 private final HashedWheelTimer hashedWheelTimer;
135 private ConnectionContext primaryConnectionContext;
136 private final DeviceState deviceState;
137 private final DataBroker dataBroker;
138 private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
139 private TransactionChainManager transactionChainManager;
140 private DeviceFlowRegistry deviceFlowRegistry;
141 private DeviceGroupRegistry deviceGroupRegistry;
142 private DeviceMeterRegistry deviceMeterRegistry;
143 private final PacketInRateLimiter packetInLimiter;
144 private final MessageSpy messageSpy;
145 private final ItemLifeCycleKeeper flowLifeCycleKeeper;
146 private NotificationPublishService notificationPublishService;
147 private Timeout barrierTaskTimeout;
148 private final MessageTranslator<PortGrouping, FlowCapableNodeConnector> portStatusTranslator;
149 private final MessageTranslator<PacketInMessage, PacketReceived> packetInTranslator;
150 private final MessageTranslator<FlowRemoved, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved> flowRemovedTranslator;
151 private final TranslatorLibrary translatorLibrary;
152 private final ItemLifeCycleRegistry itemLifeCycleSourceRegistry;
153 private ExtensionConverterProvider extensionConverterProvider;
154 private final DeviceManager deviceManager;
155 private boolean skipTableFeatures;
156 private boolean switchFeaturesMandatory;
157 private final DeviceInfo deviceInfo;
158 private final ConvertorExecutor convertorExecutor;
159 private volatile CONTEXT_STATE state;
160 private ClusterInitializationPhaseHandler clusterInitializationPhaseHandler;
161 private final DeviceManager myManager;
164 @Nonnull final ConnectionContext primaryConnectionContext,
165 @Nonnull final DataBroker dataBroker,
166 @Nonnull final MessageSpy messageSpy,
167 @Nonnull final TranslatorLibrary translatorLibrary,
168 @Nonnull final DeviceManager manager,
169 final ConvertorExecutor convertorExecutor,
170 final boolean skipTableFeatures,
171 final HashedWheelTimer hashedWheelTimer,
172 final DeviceManager myManager) {
173 this.primaryConnectionContext = primaryConnectionContext;
174 this.deviceInfo = primaryConnectionContext.getDeviceInfo();
175 this.hashedWheelTimer = hashedWheelTimer;
176 this.myManager = myManager;
177 this.deviceState = new DeviceStateImpl();
178 this.dataBroker = dataBroker;
179 this.auxiliaryConnectionContexts = new HashMap<>();
180 this.messageSpy = Preconditions.checkNotNull(messageSpy);
181 this.deviceManager = manager;
183 this.packetInLimiter = new PacketInRateLimiter(primaryConnectionContext.getConnectionAdapter(),
184 /*initial*/ 1000, /*initial*/2000, this.messageSpy, REJECTED_DRAIN_FACTOR);
186 this.translatorLibrary = translatorLibrary;
187 this.portStatusTranslator = translatorLibrary.lookupTranslator(
188 new TranslatorKey(deviceInfo.getVersion(), PortGrouping.class.getName()));
189 this.packetInTranslator = translatorLibrary.lookupTranslator(
190 new TranslatorKey(deviceInfo.getVersion(), PacketIn.class.getName()));
191 this.flowRemovedTranslator = translatorLibrary.lookupTranslator(
192 new TranslatorKey(deviceInfo.getVersion(), FlowRemoved.class.getName()));
194 this.itemLifeCycleSourceRegistry = new ItemLifeCycleRegistryImpl();
195 this.flowLifeCycleKeeper = new ItemLifeCycleSourceImpl();
196 this.itemLifeCycleSourceRegistry.registerLifeCycleSource(flowLifeCycleKeeper);
197 this.state = CONTEXT_STATE.INITIALIZATION;
198 this.convertorExecutor = convertorExecutor;
199 this.skipTableFeatures = skipTableFeatures;
200 this.initialized = false;
204 public void initialSubmitTransaction() {
206 transactionChainManager.initialSubmitWriteTransaction();
211 public void addAuxiliaryConnectionContext(final ConnectionContext connectionContext) {
212 final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
213 auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
216 private static SwitchConnectionDistinguisher createConnectionDistinguisher(final ConnectionContext connectionContext) {
217 return new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
221 public void removeAuxiliaryConnectionContext(final ConnectionContext connectionContext) {
222 final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
223 LOG.debug("auxiliary connection dropped: {}, nodeId:{}", connectionContext.getConnectionAdapter()
224 .getRemoteAddress(), getDeviceInfo().getLOGValue());
225 auxiliaryConnectionContexts.remove(connectionDistinguisher);
229 public DeviceState getDeviceState() {
234 public ReadOnlyTransaction getReadTransaction() {
235 return dataBroker.newReadOnlyTransaction();
239 public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
240 final InstanceIdentifier<T> path,
243 transactionChainManager.writeToTransaction(store, path, data, false);
248 public <T extends DataObject> void writeToTransactionWithParentsSlow(final LogicalDatastoreType store,
249 final InstanceIdentifier<T> path,
252 transactionChainManager.writeToTransaction(store, path, data, true);
257 public <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path) {
259 transactionChainManager.addDeleteOperationTotTxChain(store, path);
264 public boolean submitTransaction() {
265 return initialized && transactionChainManager.submitWriteTransaction();
269 public ConnectionContext getPrimaryConnectionContext() {
270 return primaryConnectionContext;
274 public ConnectionContext getAuxiliaryConnectionContexts(final BigInteger cookie) {
275 return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
279 public DeviceFlowRegistry getDeviceFlowRegistry() {
280 return deviceFlowRegistry;
284 public DeviceGroupRegistry getDeviceGroupRegistry() {
285 return deviceGroupRegistry;
289 public DeviceMeterRegistry getDeviceMeterRegistry() {
290 return deviceMeterRegistry;
294 public void processReply(final OfHeader ofHeader) {
295 if (ofHeader instanceof Error) {
296 messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
298 messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
303 public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
304 for (final MultipartReply multipartReply : ofHeaderList) {
305 messageSpy.spyMessage(multipartReply.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
310 public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
311 //1. translate to general flow (table, priority, match, cookie)
312 final org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved flowRemovedNotification =
313 flowRemovedTranslator.translate(flowRemoved, deviceInfo, null);
315 if(!deviceManager.getIsNotificationFlowRemovedOff()) {
316 // Trigger off a notification
317 notificationPublishService.offerNotification(flowRemovedNotification);
318 } else if(LOG.isDebugEnabled()) {
319 LOG.debug("For nodeId={} isNotificationFlowRemovedOff={}", getDeviceInfo().getLOGValue(), deviceManager.getIsNotificationFlowRemovedOff());
322 final ItemLifecycleListener itemLifecycleListener = flowLifeCycleKeeper.getItemLifecycleListener();
323 if (itemLifecycleListener != null) {
324 //2. create registry key
325 final FlowRegistryKey flowRegKey = FlowRegistryKeyFactory.create(flowRemovedNotification);
327 final FlowDescriptor flowDescriptor = deviceFlowRegistry.retrieveIdForFlow(flowRegKey);
328 //4. if flowId present:
329 if (flowDescriptor != null) {
330 // a) construct flow path
331 final KeyedInstanceIdentifier<Flow, FlowKey> flowPath = getDeviceInfo().getNodeInstanceIdentifier()
332 .augmentation(FlowCapableNode.class)
333 .child(Table.class, flowDescriptor.getTableKey())
334 .child(Flow.class, new FlowKey(flowDescriptor.getFlowId()));
335 // b) notify listener
336 itemLifecycleListener.onRemoved(flowPath);
338 LOG.debug("flow id not found: nodeId={} tableId={}, priority={}",
339 getDeviceInfo().getNodeId(), flowRegKey.getTableId(), flowRemovedNotification.getPriority());
345 public void processPortStatusMessage(final PortStatusMessage portStatus) {
346 messageSpy.spyMessage(portStatus.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
347 final FlowCapableNodeConnector flowCapableNodeConnector = portStatusTranslator.translate(portStatus, getDeviceInfo(), null);
349 final KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> iiToNodeConnector = provideIIToNodeConnector(portStatus.getPortNo(), portStatus.getVersion());
351 if (portStatus.getReason().equals(PortReason.OFPPRADD) || portStatus.getReason().equals(PortReason.OFPPRMODIFY)) {
352 // because of ADD status node connector has to be created
353 final NodeConnectorBuilder nConnectorBuilder = new NodeConnectorBuilder().setKey(iiToNodeConnector.getKey());
354 nConnectorBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
355 nConnectorBuilder.addAugmentation(FlowCapableNodeConnector.class, flowCapableNodeConnector);
356 writeToTransaction(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector, nConnectorBuilder.build());
357 } else if (portStatus.getReason().equals(PortReason.OFPPRDELETE)) {
358 addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector);
361 } catch (final Exception e) {
362 LOG.warn("Error processing port status message for port {} on device {} : {}", portStatus.getPortNo(),
363 getDeviceInfo().getNodeId().toString(), e);
367 private KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> provideIIToNodeConnector(final long portNo, final short version) {
368 final InstanceIdentifier<Node> iiToNodes = getDeviceInfo().getNodeInstanceIdentifier();
369 final BigInteger dataPathId = getDeviceInfo().getDatapathId();
370 final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), portNo, version);
371 return iiToNodes.child(NodeConnector.class, new NodeConnectorKey(nodeConnectorId));
375 public void processPacketInMessage(final PacketInMessage packetInMessage) {
376 messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH);
377 final ConnectionAdapter connectionAdapter = getPrimaryConnectionContext().getConnectionAdapter();
378 final PacketReceived packetReceived = packetInTranslator.translate(packetInMessage, getDeviceInfo(), null);
380 if (packetReceived == null) {
381 LOG.debug("Received a null packet from switch {}", connectionAdapter.getRemoteAddress());
382 messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_SRC_FAILURE);
385 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_OUT_SUCCESS);
388 if (!packetInLimiter.acquirePermit()) {
389 LOG.debug("Packet limited");
390 // TODO: save packet into emergency slot if possible
391 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PACKET_IN_LIMIT_REACHED_AND_DROPPED);
395 final ListenableFuture<?> offerNotification = notificationPublishService.offerNotification(packetReceived);
396 if (NotificationPublishService.REJECTED.equals(offerNotification)) {
397 LOG.debug("notification offer rejected");
398 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
399 packetInLimiter.drainLowWaterMark();
400 packetInLimiter.releasePermit();
404 Futures.addCallback(offerNotification, new FutureCallback<Object>() {
406 public void onSuccess(final Object result) {
407 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
408 packetInLimiter.releasePermit();
412 public void onFailure(final Throwable t) {
413 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
414 LOG.debug("notification offer failed: {}", t.getMessage());
415 LOG.trace("notification offer failed..", t);
416 packetInLimiter.releasePermit();
422 public void processExperimenterMessage(final ExperimenterMessage notification) {
424 final ExperimenterDataOfChoice vendorData = notification.getExperimenterDataOfChoice();
425 final MessageTypeKey<? extends ExperimenterDataOfChoice> key = new MessageTypeKey<>(
426 getDeviceInfo().getVersion(),
427 (Class<? extends ExperimenterDataOfChoice>) vendorData.getImplementedInterface());
428 final ConvertorMessageFromOFJava<ExperimenterDataOfChoice, MessagePath> messageConverter = extensionConverterProvider.getMessageConverter(key);
429 if (messageConverter == null) {
430 LOG.warn("custom converter for {}[OF:{}] not found",
431 notification.getExperimenterDataOfChoice().getImplementedInterface(),
432 getDeviceInfo().getVersion());
435 // build notification
436 final ExperimenterMessageOfChoice messageOfChoice;
438 messageOfChoice = messageConverter.convert(vendorData, MessagePath.MESSAGE_NOTIFICATION);
439 final ExperimenterMessageFromDevBuilder experimenterMessageFromDevBld = new ExperimenterMessageFromDevBuilder()
440 .setNode(new NodeRef(getDeviceInfo().getNodeInstanceIdentifier()))
441 .setExperimenterMessageOfChoice(messageOfChoice);
443 notificationPublishService.offerNotification(experimenterMessageFromDevBld.build());
444 } catch (final ConversionException e) {
445 LOG.error("Conversion of experimenter notification failed", e);
450 public TranslatorLibrary oook() {
451 return translatorLibrary;
455 public synchronized void close() {
456 LOG.debug("closing deviceContext: {}, nodeId:{}",
457 getPrimaryConnectionContext().getConnectionAdapter().getRemoteAddress(),
458 getDeviceInfo().getLOGValue());
460 throw new UnsupportedOperationException("Autocloseble.close will be removed soon");
464 public void setCurrentBarrierTimeout(final Timeout timeout) {
465 barrierTaskTimeout = timeout;
469 public Timeout getBarrierTaskTimeout() {
470 return barrierTaskTimeout;
474 public void setNotificationPublishService(final NotificationPublishService notificationPublishService) {
475 this.notificationPublishService = notificationPublishService;
479 public MessageSpy getMessageSpy() {
484 public void onPublished() {
485 Verify.verify(CONTEXT_STATE.INITIALIZATION.equals(getState()));
486 setState(CONTEXT_STATE.WORKING);
487 primaryConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
488 for (final ConnectionContext switchAuxConnectionContext : auxiliaryConnectionContexts.values()) {
489 switchAuxConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
494 public MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext) {
495 return new MultiMsgCollectorImpl(this, requestContext);
499 public void updatePacketInRateLimit(final long upperBound) {
500 packetInLimiter.changeWaterMarks((int) (LOW_WATERMARK_FACTOR * upperBound), (int) (HIGH_WATERMARK_FACTOR * upperBound));
504 public ItemLifeCycleRegistry getItemLifeCycleSourceRegistry() {
505 return itemLifeCycleSourceRegistry;
509 public void setExtensionConverterProvider(final ExtensionConverterProvider extensionConverterProvider) {
510 this.extensionConverterProvider = extensionConverterProvider;
514 public ExtensionConverterProvider getExtensionConverterProvider() {
515 return extensionConverterProvider;
519 public synchronized void shutdownConnection() {
520 if (LOG.isDebugEnabled()) {
521 LOG.debug("Shutdown method for node {}", getDeviceInfo().getLOGValue());
523 if (CONTEXT_STATE.TERMINATION.equals(getState())) {
524 LOG.debug("DeviceCtx for Node {} is in termination process.", getDeviceInfo().getLOGValue());
528 if (ConnectionContext.CONNECTION_STATE.RIP.equals(getPrimaryConnectionContext().getConnectionState())) {
529 LOG.debug("ConnectionCtx for Node {} is in RIP state.", getDeviceInfo().getLOGValue());
533 // Terminate Auxiliary Connection
534 for (final ConnectionContext connectionContext : auxiliaryConnectionContexts.values()) {
535 LOG.debug("Closing auxiliary connection {}", connectionContext.getNodeId());
536 connectionContext.closeConnection(false);
539 // Terminate Primary Connection
540 getPrimaryConnectionContext().closeConnection(true);
542 // Close all datastore registries
544 deviceGroupRegistry.close();
545 deviceFlowRegistry.close();
546 deviceMeterRegistry.close();
551 public ListenableFuture<Void> shuttingDownDataStoreTransactions() {
553 ? this.transactionChainManager.shuttingDown()
554 : Futures.immediateFuture(null);
558 TransactionChainManager getTransactionChainManager() {
559 return this.transactionChainManager;
563 public void setSwitchFeaturesMandatory(boolean switchFeaturesMandatory) {
564 this.switchFeaturesMandatory = switchFeaturesMandatory;
568 public CONTEXT_STATE getState() {
573 public void setState(CONTEXT_STATE state) {
578 public ListenableFuture<Void> stopClusterServices(boolean deviceDisconnected) {
580 ListenableFuture<Void> deactivateTxManagerFuture =
581 initialized ? transactionChainManager.deactivateTransactionManager() : Futures.immediateFuture(null);
583 if (!deviceDisconnected) {
584 ListenableFuture<Void> makeSlaveFuture = Futures.transform(makeDeviceSlave(), new Function<RpcResult<SetRoleOutput>, Void>() {
587 public Void apply(@Nullable RpcResult<SetRoleOutput> setRoleOutputRpcResult) {
592 Futures.addCallback(makeSlaveFuture, new FutureCallback<Void>() {
594 public void onSuccess(@Nullable Void aVoid) {
595 if (LOG.isDebugEnabled()) {
596 LOG.debug("Role SLAVE was successfully propagated on device, node {}", deviceInfo.getLOGValue());
601 public void onFailure(final Throwable throwable) {
602 LOG.warn("Was not able to set role SLAVE to device on node {} ", deviceInfo.getLOGValue());
603 LOG.trace("Error occurred on device role setting, probably connection loss: ", throwable);
604 myManager.removeDeviceFromOperationalDS(deviceInfo);
608 return Futures.transform(deactivateTxManagerFuture, new AsyncFunction<Void, Void>() {
610 public ListenableFuture<Void> apply(Void aVoid) throws Exception {
611 return makeSlaveFuture;
615 return Futures.transform(deactivateTxManagerFuture, new AsyncFunction<Void, Void>() {
617 public ListenableFuture<Void> apply(Void aVoid) throws Exception {
618 return myManager.removeDeviceFromOperationalDS(deviceInfo);
625 public ServiceGroupIdentifier getServiceIdentifier() {
626 return this.deviceInfo.getServiceIdentifier();
630 public DeviceInfo getDeviceInfo() {
631 return this.deviceInfo;
635 public void putLifecycleServiceIntoTxChainManager(final LifecycleService lifecycleService){
637 this.transactionChainManager.setLifecycleService(lifecycleService);
642 public void replaceConnectionContext(final ConnectionContext connectionContext){
643 // Act like we are initializing the context
644 setState(CONTEXT_STATE.INITIALIZATION);
645 this.primaryConnectionContext = connectionContext;
650 public boolean isSkipTableFeatures() {
651 return this.skipTableFeatures;
655 public void setSalRoleService(@Nonnull SalRoleService salRoleService) {
656 this.salRoleService = salRoleService;
660 public void setLifecycleInitializationPhaseHandler(final ClusterInitializationPhaseHandler handler) {
661 this.clusterInitializationPhaseHandler = handler;
665 public boolean onContextInstantiateService(final ConnectionContext connectionContext) {
667 if (getPrimaryConnectionContext().getConnectionState().equals(ConnectionContext.CONNECTION_STATE.RIP)) {
668 LOG.warn("Connection on device {} was interrupted, will stop starting master services.", deviceInfo.getLOGValue());
672 LOG.info("Starting device context cluster services for node {}", deviceInfo.getLOGValue());
674 lazyTransactionManagerInitialization();
676 this.transactionChainManager.activateTransactionManager();
679 DeviceInitializationUtils.initializeNodeInformation(this, switchFeaturesMandatory, this.convertorExecutor);
680 } catch (ExecutionException | InterruptedException e) {
681 LOG.warn("Device {} cannot be initialized: ", deviceInfo.getLOGValue(), e);
685 Futures.addCallback(sendRoleChangeToDevice(OfpRole.BECOMEMASTER), new RpcResultFutureCallback());
687 return this.clusterInitializationPhaseHandler.onContextInstantiateService(getPrimaryConnectionContext());
691 void lazyTransactionManagerInitialization() {
692 if (!this.initialized) {
693 if (LOG.isDebugEnabled()) {
694 LOG.debug("Transaction chain manager for node {} created", deviceInfo.getLOGValue());
696 this.transactionChainManager = new TransactionChainManager(dataBroker, deviceInfo);
697 this.deviceFlowRegistry = new DeviceFlowRegistryImpl(dataBroker, deviceInfo.getNodeInstanceIdentifier());
698 this.deviceGroupRegistry = new DeviceGroupRegistryImpl();
699 this.deviceMeterRegistry = new DeviceMeterRegistryImpl();
700 this.initialized = true;
706 public <T> RequestContext<T> createRequestContext() {
707 return new AbstractRequestContext<T>(deviceInfo.reserveXidForDeviceMessage()) {
709 public void close() {
715 ListenableFuture<RpcResult<SetRoleOutput>> sendRoleChangeToDevice(final OfpRole newRole) {
716 if (LOG.isDebugEnabled()) {
717 LOG.debug("Sending new role {} to device {}", newRole, deviceInfo.getNodeId());
719 final Future<RpcResult<SetRoleOutput>> setRoleOutputFuture;
720 if (deviceInfo.getVersion() >= OFConstants.OFP_VERSION_1_3) {
721 final SetRoleInput setRoleInput = (new SetRoleInputBuilder()).setControllerRole(newRole)
722 .setNode(new NodeRef(deviceInfo.getNodeInstanceIdentifier())).build();
723 setRoleOutputFuture = this.salRoleService.setRole(setRoleInput);
724 final TimerTask timerTask = timeout -> {
725 if (!setRoleOutputFuture.isDone()) {
726 LOG.warn("New role {} was not propagated to device {} during {} sec", newRole, deviceInfo.getLOGValue(), SET_ROLE_TIMEOUT);
727 setRoleOutputFuture.cancel(true);
730 hashedWheelTimer.newTimeout(timerTask, SET_ROLE_TIMEOUT, TimeUnit.SECONDS);
732 LOG.info("Device: {} with version: {} does not support role", deviceInfo.getLOGValue(), deviceInfo.getVersion());
733 return Futures.immediateFuture(null);
735 return JdkFutureAdapters.listenInPoolThread(setRoleOutputFuture);
739 public ListenableFuture<RpcResult<SetRoleOutput>> makeDeviceSlave() {
740 return sendRoleChangeToDevice(OfpRole.BECOMESLAVE);
743 private class RpcResultFutureCallback implements FutureCallback<RpcResult<SetRoleOutput>> {
745 public void onSuccess(@Nullable RpcResult<SetRoleOutput> setRoleOutputRpcResult) {
746 if (LOG.isDebugEnabled()) {
747 LOG.debug("Role MASTER was successfully set on device, node {}", deviceInfo.getLOGValue());
752 public void onFailure(final Throwable throwable) {
753 LOG.warn("Was not able to set MASTER role on device, node {}", deviceInfo.getLOGValue());
754 shutdownConnection();