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.Preconditions;
12 import com.google.common.base.Verify;
13 import com.google.common.util.concurrent.FutureCallback;
14 import com.google.common.util.concurrent.Futures;
15 import com.google.common.util.concurrent.ListenableFuture;
16 import io.netty.util.Timeout;
17 import java.math.BigInteger;
18 import java.util.HashMap;
19 import java.util.List;
21 import java.util.concurrent.ExecutionException;
22 import javax.annotation.Nonnull;
23 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
24 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
25 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
26 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
27 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainClosedException;
28 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
29 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
30 import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
31 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
32 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
33 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
34 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
35 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
36 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
37 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
38 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
39 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
40 import org.opendaylight.openflowplugin.api.openflow.device.handlers.ClusterInitializationPhaseHandler;
41 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
42 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
43 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
44 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
45 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
46 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
47 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowDescriptor;
48 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowRegistryKey;
49 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
50 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
51 import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleKeeper;
52 import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
53 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
54 import org.opendaylight.openflowplugin.extension.api.ConvertorMessageFromOFJava;
55 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterProviderKeeper;
56 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
57 import org.opendaylight.openflowplugin.extension.api.exception.ConversionException;
58 import org.opendaylight.openflowplugin.extension.api.path.MessagePath;
59 import org.opendaylight.openflowplugin.impl.common.ItemLifeCycleSourceImpl;
60 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
61 import org.opendaylight.openflowplugin.impl.device.listener.MultiMsgCollectorImpl;
62 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
63 import org.opendaylight.openflowplugin.impl.registry.flow.FlowRegistryKeyFactory;
64 import org.opendaylight.openflowplugin.impl.registry.group.DeviceGroupRegistryImpl;
65 import org.opendaylight.openflowplugin.impl.registry.meter.DeviceMeterRegistryImpl;
66 import org.opendaylight.openflowplugin.impl.util.DeviceInitializationUtils;
67 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
68 import org.opendaylight.openflowplugin.openflow.md.core.session.SwitchConnectionCookieOFImpl;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.experimenter.message.service.rev151020.ExperimenterMessageFromDevBuilder;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortReason;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketIn;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.experimenter.core.ExperimenterDataOfChoice;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.experimenter.types.rev151020.experimenter.core.message.ExperimenterMessageOfChoice;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
96 import org.opendaylight.yangtools.yang.binding.DataObject;
97 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
98 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
99 import org.slf4j.Logger;
100 import org.slf4j.LoggerFactory;
105 public class DeviceContextImpl implements DeviceContext, ExtensionConverterProviderKeeper{
107 private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
109 // TODO: drain factor should be parametrized
110 private static final float REJECTED_DRAIN_FACTOR = 0.25f;
111 // TODO: low water mark factor should be parametrized
112 private static final float LOW_WATERMARK_FACTOR = 0.75f;
113 // TODO: high water mark factor should be parametrized
114 private static final float HIGH_WATERMARK_FACTOR = 0.95f;
116 private ConnectionContext primaryConnectionContext;
117 private final DeviceState deviceState;
118 private final DataBroker dataBroker;
119 private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
120 private final TransactionChainManager transactionChainManager;
121 private final DeviceFlowRegistry deviceFlowRegistry;
122 private final DeviceGroupRegistry deviceGroupRegistry;
123 private final DeviceMeterRegistry deviceMeterRegistry;
124 private final PacketInRateLimiter packetInLimiter;
125 private final MessageSpy messageSpy;
126 private final ItemLifeCycleKeeper flowLifeCycleKeeper;
127 private NotificationPublishService notificationPublishService;
128 private Timeout barrierTaskTimeout;
129 private final MessageTranslator<PortGrouping, FlowCapableNodeConnector> portStatusTranslator;
130 private final MessageTranslator<PacketInMessage, PacketReceived> packetInTranslator;
131 private final MessageTranslator<FlowRemoved, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved> flowRemovedTranslator;
132 private final TranslatorLibrary translatorLibrary;
133 private final ItemLifeCycleRegistry itemLifeCycleSourceRegistry;
134 private ExtensionConverterProvider extensionConverterProvider;
135 private final DeviceManager deviceManager;
136 private boolean skipTableFeatures;
137 private boolean switchFeaturesMandatory;
138 private final DeviceInfo deviceInfo;
139 private final ConvertorExecutor convertorExecutor;
140 private volatile CONTEXT_STATE state;
141 private ClusterInitializationPhaseHandler clusterInitializationPhaseHandler;
143 public DeviceContextImpl(
144 @Nonnull final ConnectionContext primaryConnectionContext,
145 @Nonnull final DataBroker dataBroker,
146 @Nonnull final MessageSpy messageSpy,
147 @Nonnull final TranslatorLibrary translatorLibrary,
148 @Nonnull final DeviceManager manager,
149 final ConvertorExecutor convertorExecutor,
150 final boolean skipTableFeatures) {
151 this.primaryConnectionContext = Preconditions.checkNotNull(primaryConnectionContext);
152 this.deviceInfo = primaryConnectionContext.getDeviceInfo();
153 this.deviceState = new DeviceStateImpl();
154 this.dataBroker = Preconditions.checkNotNull(dataBroker);
155 this.transactionChainManager = new TransactionChainManager(dataBroker, deviceInfo);
156 auxiliaryConnectionContexts = new HashMap<>();
157 deviceFlowRegistry = new DeviceFlowRegistryImpl(dataBroker, deviceInfo.getNodeInstanceIdentifier());
158 deviceGroupRegistry = new DeviceGroupRegistryImpl();
159 deviceMeterRegistry = new DeviceMeterRegistryImpl();
160 this.messageSpy = Preconditions.checkNotNull(messageSpy);
161 this.deviceManager = Preconditions.checkNotNull(manager);
163 packetInLimiter = new PacketInRateLimiter(primaryConnectionContext.getConnectionAdapter(),
164 /*initial*/ 1000, /*initial*/2000, this.messageSpy, REJECTED_DRAIN_FACTOR);
166 this.translatorLibrary = translatorLibrary;
167 portStatusTranslator = translatorLibrary.lookupTranslator(
168 new TranslatorKey(deviceInfo.getVersion(), PortGrouping.class.getName()));
169 packetInTranslator = translatorLibrary.lookupTranslator(
170 new TranslatorKey(deviceInfo.getVersion(), PacketIn.class.getName()));
171 flowRemovedTranslator = translatorLibrary.lookupTranslator(
172 new TranslatorKey(deviceInfo.getVersion(), FlowRemoved.class.getName()));
174 itemLifeCycleSourceRegistry = new ItemLifeCycleRegistryImpl();
175 flowLifeCycleKeeper = new ItemLifeCycleSourceImpl();
176 itemLifeCycleSourceRegistry.registerLifeCycleSource(flowLifeCycleKeeper);
177 this.state = CONTEXT_STATE.INITIALIZATION;
178 this.convertorExecutor = convertorExecutor;
179 this.skipTableFeatures = skipTableFeatures;
183 * This method is called from {@link DeviceManagerImpl} only. So we could say "posthandshake process finish"
184 * and we are able to set a scheduler for an automatic transaction submitting by time (0,5sec).
187 public void initialSubmitTransaction() {
188 transactionChainManager.initialSubmitWriteTransaction();
192 public void addAuxiliaryConnectionContext(final ConnectionContext connectionContext) {
193 final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
194 auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
197 private static SwitchConnectionDistinguisher createConnectionDistinguisher(final ConnectionContext connectionContext) {
198 return new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
202 public void removeAuxiliaryConnectionContext(final ConnectionContext connectionContext) {
203 final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
204 LOG.debug("auxiliary connection dropped: {}, nodeId:{}", connectionContext.getConnectionAdapter()
205 .getRemoteAddress(), getDeviceInfo().getLOGValue());
206 auxiliaryConnectionContexts.remove(connectionDistinguisher);
210 public DeviceState getDeviceState() {
215 public ReadOnlyTransaction getReadTransaction() {
216 return dataBroker.newReadOnlyTransaction();
220 public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
221 final InstanceIdentifier<T> path,
223 transactionChainManager.writeToTransaction(store, path, data, false);
227 public <T extends DataObject> void writeToTransactionWithParentsSlow(final LogicalDatastoreType store,
228 final InstanceIdentifier<T> path,
230 transactionChainManager.writeToTransaction(store, path, data, true);
234 public <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path) throws TransactionChainClosedException {
235 transactionChainManager.addDeleteOperationTotTxChain(store, path);
239 public boolean submitTransaction() {
240 return transactionChainManager.submitWriteTransaction();
244 public ConnectionContext getPrimaryConnectionContext() {
245 return primaryConnectionContext;
249 public ConnectionContext getAuxiliaryConnectiobContexts(final BigInteger cookie) {
250 return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
254 public DeviceFlowRegistry getDeviceFlowRegistry() {
255 return deviceFlowRegistry;
259 public DeviceGroupRegistry getDeviceGroupRegistry() {
260 return deviceGroupRegistry;
264 public DeviceMeterRegistry getDeviceMeterRegistry() {
265 return deviceMeterRegistry;
269 public void processReply(final OfHeader ofHeader) {
270 if (ofHeader instanceof Error) {
271 messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
273 messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
278 public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
279 for (final MultipartReply multipartReply : ofHeaderList) {
280 messageSpy.spyMessage(multipartReply.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
285 public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
286 //1. translate to general flow (table, priority, match, cookie)
287 final org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved flowRemovedNotification =
288 flowRemovedTranslator.translate(flowRemoved, deviceInfo, null);
290 if(!deviceManager.getIsNotificationFlowRemovedOff()) {
291 // Trigger off a notification
292 notificationPublishService.offerNotification(flowRemovedNotification);
293 } else if(LOG.isDebugEnabled()) {
294 LOG.debug("For nodeId={} isNotificationFlowRemovedOff={}", getDeviceInfo().getLOGValue(), deviceManager.getIsNotificationFlowRemovedOff());
297 final ItemLifecycleListener itemLifecycleListener = flowLifeCycleKeeper.getItemLifecycleListener();
298 if (itemLifecycleListener != null) {
299 //2. create registry key
300 final FlowRegistryKey flowRegKey = FlowRegistryKeyFactory.create(flowRemovedNotification);
302 final FlowDescriptor flowDescriptor = deviceFlowRegistry.retrieveIdForFlow(flowRegKey);
303 //4. if flowId present:
304 if (flowDescriptor != null) {
305 // a) construct flow path
306 final KeyedInstanceIdentifier<Flow, FlowKey> flowPath = getDeviceInfo().getNodeInstanceIdentifier()
307 .augmentation(FlowCapableNode.class)
308 .child(Table.class, flowDescriptor.getTableKey())
309 .child(Flow.class, new FlowKey(flowDescriptor.getFlowId()));
310 // b) notify listener
311 itemLifecycleListener.onRemoved(flowPath);
313 LOG.debug("flow id not found: nodeId={} tableId={}, priority={}",
314 getDeviceInfo().getNodeId(), flowRegKey.getTableId(), flowRemovedNotification.getPriority());
320 public void processPortStatusMessage(final PortStatusMessage portStatus) {
321 messageSpy.spyMessage(portStatus.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
322 final FlowCapableNodeConnector flowCapableNodeConnector = portStatusTranslator.translate(portStatus, getDeviceInfo(), null);
324 final KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> iiToNodeConnector = provideIIToNodeConnector(portStatus.getPortNo(), portStatus.getVersion());
326 if (portStatus.getReason().equals(PortReason.OFPPRADD) || portStatus.getReason().equals(PortReason.OFPPRMODIFY)) {
327 // because of ADD status node connector has to be created
328 final NodeConnectorBuilder nConnectorBuilder = new NodeConnectorBuilder().setKey(iiToNodeConnector.getKey());
329 nConnectorBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
330 nConnectorBuilder.addAugmentation(FlowCapableNodeConnector.class, flowCapableNodeConnector);
331 writeToTransaction(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector, nConnectorBuilder.build());
332 } else if (portStatus.getReason().equals(PortReason.OFPPRDELETE)) {
333 addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector);
336 } catch (final Exception e) {
337 LOG.warn("Error processing port status message: ", e);
341 private KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> provideIIToNodeConnector(final long portNo, final short version) {
342 final InstanceIdentifier<Node> iiToNodes = getDeviceInfo().getNodeInstanceIdentifier();
343 final BigInteger dataPathId = getDeviceInfo().getDatapathId();
344 final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), portNo, version);
345 return iiToNodes.child(NodeConnector.class, new NodeConnectorKey(nodeConnectorId));
349 public void processPacketInMessage(final PacketInMessage packetInMessage) {
350 messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH);
351 final ConnectionAdapter connectionAdapter = getPrimaryConnectionContext().getConnectionAdapter();
352 final PacketReceived packetReceived = packetInTranslator.translate(packetInMessage, getDeviceInfo(), null);
354 if (packetReceived == null) {
355 LOG.debug("Received a null packet from switch {}", connectionAdapter.getRemoteAddress());
356 messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_SRC_FAILURE);
359 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_OUT_SUCCESS);
362 if (!packetInLimiter.acquirePermit()) {
363 LOG.debug("Packet limited");
364 // TODO: save packet into emergency slot if possible
365 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PACKET_IN_LIMIT_REACHED_AND_DROPPED);
369 final ListenableFuture<?> offerNotification = notificationPublishService.offerNotification(packetReceived);
370 if (NotificationPublishService.REJECTED.equals(offerNotification)) {
371 LOG.debug("notification offer rejected");
372 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
373 packetInLimiter.drainLowWaterMark();
374 packetInLimiter.releasePermit();
378 Futures.addCallback(offerNotification, new FutureCallback<Object>() {
380 public void onSuccess(final Object result) {
381 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
382 packetInLimiter.releasePermit();
386 public void onFailure(final Throwable t) {
387 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
388 LOG.debug("notification offer failed: {}", t.getMessage());
389 LOG.trace("notification offer failed..", t);
390 packetInLimiter.releasePermit();
396 public void processExperimenterMessage(final ExperimenterMessage notification) {
398 final ExperimenterDataOfChoice vendorData = notification.getExperimenterDataOfChoice();
399 final MessageTypeKey<? extends ExperimenterDataOfChoice> key = new MessageTypeKey<>(
400 getDeviceInfo().getVersion(),
401 (Class<? extends ExperimenterDataOfChoice>) vendorData.getImplementedInterface());
402 final ConvertorMessageFromOFJava<ExperimenterDataOfChoice, MessagePath> messageConverter = extensionConverterProvider.getMessageConverter(key);
403 if (messageConverter == null) {
404 LOG.warn("custom converter for {}[OF:{}] not found",
405 notification.getExperimenterDataOfChoice().getImplementedInterface(),
406 getDeviceInfo().getVersion());
409 // build notification
410 final ExperimenterMessageOfChoice messageOfChoice;
412 messageOfChoice = messageConverter.convert(vendorData, MessagePath.MESSAGE_NOTIFICATION);
413 final ExperimenterMessageFromDevBuilder experimenterMessageFromDevBld = new ExperimenterMessageFromDevBuilder()
414 .setNode(new NodeRef(getDeviceInfo().getNodeInstanceIdentifier()))
415 .setExperimenterMessageOfChoice(messageOfChoice);
417 notificationPublishService.offerNotification(experimenterMessageFromDevBld.build());
418 } catch (final ConversionException e) {
419 LOG.error("Conversion of experimenter notification failed", e);
424 public TranslatorLibrary oook() {
425 return translatorLibrary;
429 public synchronized void close() {
430 LOG.debug("closing deviceContext: {}, nodeId:{}",
431 getPrimaryConnectionContext().getConnectionAdapter().getRemoteAddress(),
432 getDeviceInfo().getLOGValue());
434 throw new UnsupportedOperationException("Autocloseble.close will be removed soon");
438 public void setCurrentBarrierTimeout(final Timeout timeout) {
439 barrierTaskTimeout = timeout;
443 public Timeout getBarrierTaskTimeout() {
444 return barrierTaskTimeout;
448 public void setNotificationPublishService(final NotificationPublishService notificationPublishService) {
449 this.notificationPublishService = notificationPublishService;
453 public MessageSpy getMessageSpy() {
458 public void onPublished() {
459 Verify.verify(CONTEXT_STATE.INITIALIZATION.equals(getState()));
460 setState(CONTEXT_STATE.WORKING);
461 primaryConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
462 for (final ConnectionContext switchAuxConnectionContext : auxiliaryConnectionContexts.values()) {
463 switchAuxConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
468 public MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext) {
469 return new MultiMsgCollectorImpl(this, requestContext);
473 public void updatePacketInRateLimit(final long upperBound) {
474 packetInLimiter.changeWaterMarks((int) (LOW_WATERMARK_FACTOR * upperBound), (int) (HIGH_WATERMARK_FACTOR * upperBound));
478 public ItemLifeCycleRegistry getItemLifeCycleSourceRegistry() {
479 return itemLifeCycleSourceRegistry;
483 public void setExtensionConverterProvider(final ExtensionConverterProvider extensionConverterProvider) {
484 this.extensionConverterProvider = extensionConverterProvider;
488 public ExtensionConverterProvider getExtensionConverterProvider() {
489 return extensionConverterProvider;
493 public synchronized void shutdownConnection() {
494 LOG.debug("Shutdown method for node {}", getDeviceInfo().getLOGValue());
495 if (CONTEXT_STATE.TERMINATION.equals(getState())) {
496 LOG.debug("DeviceCtx for Node {} is in termination process.", getDeviceInfo().getLOGValue());
499 setState(CONTEXT_STATE.TERMINATION);
501 if (ConnectionContext.CONNECTION_STATE.RIP.equals(getPrimaryConnectionContext().getConnectionState())) {
502 LOG.debug("ConnectionCtx for Node {} is in RIP state.", getDeviceInfo().getLOGValue());
505 /* Terminate Auxiliary Connection */
506 for (final ConnectionContext connectionContext : auxiliaryConnectionContexts.values()) {
507 LOG.debug("Closing auxiliary connection {}", connectionContext.getNodeId());
508 connectionContext.closeConnection(false);
510 /* Terminate Primary Connection */
511 getPrimaryConnectionContext().closeConnection(true);
512 /* Close all Group Registry */
513 deviceGroupRegistry.close();
514 deviceFlowRegistry.close();
515 deviceMeterRegistry.close();
519 public ListenableFuture<Void> shuttingDownDataStoreTransactions() {
520 return transactionChainManager.shuttingDown();
524 TransactionChainManager getTransactionChainManager() {
525 return this.transactionChainManager;
529 public void setSwitchFeaturesMandatory(boolean switchFeaturesMandatory) {
530 this.switchFeaturesMandatory = switchFeaturesMandatory;
534 public CONTEXT_STATE getState() {
539 public void setState(CONTEXT_STATE state) {
544 public ListenableFuture<Void> stopClusterServices(boolean deviceDisconnected) {
545 return this.transactionChainManager.deactivateTransactionManager();
549 public ServiceGroupIdentifier getServiceIdentifier() {
550 return this.deviceInfo.getServiceIdentifier();
554 public DeviceInfo getDeviceInfo() {
555 return this.deviceInfo;
559 public void putLifecycleServiceIntoTxChainManager(final LifecycleService lifecycleService){
560 this.transactionChainManager.setLifecycleService(lifecycleService);
564 public void replaceConnectionContext(final ConnectionContext connectionContext){
565 // Act like we are initializing the context
566 setState(CONTEXT_STATE.INITIALIZATION);
567 this.primaryConnectionContext = connectionContext;
572 public boolean isSkipTableFeatures() {
573 return this.skipTableFeatures;
577 public void setLifecycleInitializationPhaseHandler(final ClusterInitializationPhaseHandler handler) {
578 this.clusterInitializationPhaseHandler = handler;
582 public boolean onContextInstantiateService(final ConnectionContext connectionContext) {
584 if (getPrimaryConnectionContext().getConnectionState().equals(ConnectionContext.CONNECTION_STATE.RIP)) {
585 LOG.warn("Connection on device {} was interrupted, will stop starting master services.", deviceInfo.getLOGValue());
589 LOG.info("Starting device context cluster services for node {}", deviceInfo.getLOGValue());
591 this.transactionChainManager.activateTransactionManager();
594 DeviceInitializationUtils.initializeNodeInformation(this, switchFeaturesMandatory, this.convertorExecutor);
595 } catch (ExecutionException | InterruptedException e) {
596 LOG.warn("Device {} cannot be initialized: ", deviceInfo.getLOGValue(), e);
600 return this.clusterInitializationPhaseHandler.onContextInstantiateService(getPrimaryConnectionContext());