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.Optional;
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.JdkFutureAdapters;
16 import com.google.common.util.concurrent.ListenableFuture;
17 import io.netty.util.HashedWheelTimer;
18 import io.netty.util.Timeout;
19 import io.netty.util.TimerTask;
20 import java.math.BigInteger;
21 import java.util.Collection;
22 import java.util.HashMap;
23 import java.util.List;
25 import java.util.Objects;
26 import java.util.concurrent.ExecutionException;
27 import java.util.concurrent.Future;
28 import java.util.concurrent.TimeUnit;
29 import java.util.concurrent.TimeoutException;
30 import javax.annotation.Nonnull;
31 import javax.annotation.Nullable;
32 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
33 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
34 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
35 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
36 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
37 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
38 import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
39 import org.opendaylight.openflowplugin.api.ConnectionException;
40 import org.opendaylight.openflowplugin.api.OFConstants;
41 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
42 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
43 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
44 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
45 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
46 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
47 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
48 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
49 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
50 import org.opendaylight.openflowplugin.api.openflow.device.handlers.ClusterInitializationPhaseHandler;
51 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
52 import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChainMastershipState;
53 import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChainState;
54 import org.opendaylight.openflowplugin.api.openflow.lifecycle.MastershipChangeListener;
55 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
56 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
57 import org.opendaylight.openflowplugin.api.openflow.md.util.OpenflowVersion;
58 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
59 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
60 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowDescriptor;
61 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowRegistryKey;
62 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
63 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
64 import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleKeeper;
65 import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
66 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
67 import org.opendaylight.openflowplugin.extension.api.ConvertorMessageFromOFJava;
68 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterProviderKeeper;
69 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
70 import org.opendaylight.openflowplugin.extension.api.exception.ConversionException;
71 import org.opendaylight.openflowplugin.extension.api.path.MessagePath;
72 import org.opendaylight.openflowplugin.impl.common.ItemLifeCycleSourceImpl;
73 import org.opendaylight.openflowplugin.impl.datastore.MultipartWriterProvider;
74 import org.opendaylight.openflowplugin.impl.datastore.MultipartWriterProviderFactory;
75 import org.opendaylight.openflowplugin.impl.device.initialization.AbstractDeviceInitializer;
76 import org.opendaylight.openflowplugin.impl.device.initialization.DeviceInitializerProvider;
77 import org.opendaylight.openflowplugin.impl.device.listener.MultiMsgCollectorImpl;
78 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
79 import org.opendaylight.openflowplugin.impl.registry.flow.FlowRegistryKeyFactory;
80 import org.opendaylight.openflowplugin.impl.registry.group.DeviceGroupRegistryImpl;
81 import org.opendaylight.openflowplugin.impl.registry.meter.DeviceMeterRegistryImpl;
82 import org.opendaylight.openflowplugin.impl.rpc.AbstractRequestContext;
83 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
84 import org.opendaylight.openflowplugin.openflow.md.core.session.SwitchConnectionCookieOFImpl;
85 import org.opendaylight.openflowplugin.openflow.md.util.InventoryDataServiceUtil;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.experimenter.message.service.rev151020.ExperimenterMessageFromDevBuilder;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortReason;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
99 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
100 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
101 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketIn;
102 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
103 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
104 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatus;
105 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.experimenter.core.ExperimenterDataOfChoice;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.experimenter.types.rev151020.experimenter.core.message.ExperimenterMessageOfChoice;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SalRoleService;
113 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SetRoleInput;
114 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SetRoleInputBuilder;
115 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SetRoleOutput;
116 import org.opendaylight.yangtools.yang.binding.DataObject;
117 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
118 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
119 import org.opendaylight.yangtools.yang.common.RpcResult;
120 import org.slf4j.Logger;
121 import org.slf4j.LoggerFactory;
123 public class DeviceContextImpl implements DeviceContext, ExtensionConverterProviderKeeper {
125 private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
127 // TODO: drain factor should be parametrized
128 private static final float REJECTED_DRAIN_FACTOR = 0.25f;
129 // TODO: low water mark factor should be parametrized
130 private static final float LOW_WATERMARK_FACTOR = 0.75f;
131 // TODO: high water mark factor should be parametrized
132 private static final float HIGH_WATERMARK_FACTOR = 0.95f;
134 // Timeout in seconds after what we will give up on propagating role
135 private static final int SET_ROLE_TIMEOUT = 10;
137 // Timeout in milliseconds after what we will give up on initializing device
138 private static final int DEVICE_INIT_TIMEOUT = 9000;
140 private static final int LOW_WATERMARK = 1000;
141 private static final int HIGH_WATERMARK = 2000;
142 private final MultipartWriterProvider writerProvider;
144 private boolean initialized;
146 private SalRoleService salRoleService = null;
147 private final HashedWheelTimer hashedWheelTimer;
148 private volatile ConnectionContext primaryConnectionContext;
149 private final DeviceState deviceState;
150 private final DataBroker dataBroker;
151 private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
152 private TransactionChainManager transactionChainManager;
153 private DeviceFlowRegistry deviceFlowRegistry;
154 private DeviceGroupRegistry deviceGroupRegistry;
155 private DeviceMeterRegistry deviceMeterRegistry;
156 private PacketInRateLimiter packetInLimiter;
157 private final MessageSpy messageSpy;
158 private final ItemLifeCycleKeeper flowLifeCycleKeeper;
159 private NotificationPublishService notificationPublishService;
160 private Timeout barrierTaskTimeout;
161 private final MessageTranslator<PortGrouping, FlowCapableNodeConnector> portStatusTranslator;
162 private final MessageTranslator<PacketInMessage, PacketReceived> packetInTranslator;
163 private final MessageTranslator<FlowRemoved, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved> flowRemovedTranslator;
164 private final TranslatorLibrary translatorLibrary;
165 private final ItemLifeCycleRegistry itemLifeCycleSourceRegistry;
166 private ExtensionConverterProvider extensionConverterProvider;
167 private boolean skipTableFeatures;
168 private boolean switchFeaturesMandatory;
169 private DeviceInfo deviceInfo;
170 private final ConvertorExecutor convertorExecutor;
171 private volatile CONTEXT_STATE state;
172 private ClusterInitializationPhaseHandler clusterInitializationPhaseHandler;
173 private final DeviceManager myManager;
174 private final DeviceInitializerProvider deviceInitializerProvider;
175 private final boolean useSingleLayerSerialization;
176 private boolean hasState;
179 @Nonnull final ConnectionContext primaryConnectionContext,
180 @Nonnull final DataBroker dataBroker,
181 @Nonnull final MessageSpy messageSpy,
182 @Nonnull final TranslatorLibrary translatorLibrary,
183 @Nonnull final DeviceManager contextManager,
184 final ConvertorExecutor convertorExecutor,
185 final boolean skipTableFeatures,
186 final HashedWheelTimer hashedWheelTimer,
187 final boolean useSingleLayerSerialization,
188 final DeviceInitializerProvider deviceInitializerProvider) {
190 this.primaryConnectionContext = primaryConnectionContext;
191 this.deviceInfo = primaryConnectionContext.getDeviceInfo();
192 this.hashedWheelTimer = hashedWheelTimer;
193 this.deviceInitializerProvider = deviceInitializerProvider;
194 this.myManager = contextManager;
195 this.deviceState = new DeviceStateImpl();
196 this.dataBroker = dataBroker;
197 this.auxiliaryConnectionContexts = new HashMap<>();
198 this.messageSpy = messageSpy;
200 this.packetInLimiter = new PacketInRateLimiter(primaryConnectionContext.getConnectionAdapter(),
201 /*initial*/ LOW_WATERMARK, /*initial*/HIGH_WATERMARK, this.messageSpy, REJECTED_DRAIN_FACTOR);
203 this.translatorLibrary = translatorLibrary;
204 this.portStatusTranslator = translatorLibrary.lookupTranslator(
205 new TranslatorKey(deviceInfo.getVersion(), PortGrouping.class.getName()));
206 this.packetInTranslator = translatorLibrary.lookupTranslator(
207 new TranslatorKey(deviceInfo.getVersion(), PacketIn.class.getName()));
208 this.flowRemovedTranslator = translatorLibrary.lookupTranslator(
209 new TranslatorKey(deviceInfo.getVersion(), FlowRemoved.class.getName()));
211 this.itemLifeCycleSourceRegistry = new ItemLifeCycleRegistryImpl();
212 this.flowLifeCycleKeeper = new ItemLifeCycleSourceImpl();
213 this.itemLifeCycleSourceRegistry.registerLifeCycleSource(flowLifeCycleKeeper);
214 this.state = CONTEXT_STATE.INITIALIZATION;
215 this.convertorExecutor = convertorExecutor;
216 this.skipTableFeatures = skipTableFeatures;
217 this.useSingleLayerSerialization = useSingleLayerSerialization;
218 this.initialized = false;
219 writerProvider = MultipartWriterProviderFactory.createDefaultProvider(this);
223 public boolean initialSubmitTransaction() {
224 return (initialized && transactionChainManager.initialSubmitWriteTransaction());
228 public void addAuxiliaryConnectionContext(final ConnectionContext connectionContext) {
229 final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
230 auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
233 private static SwitchConnectionDistinguisher createConnectionDistinguisher(final ConnectionContext connectionContext) {
234 return new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
238 public void removeAuxiliaryConnectionContext(final ConnectionContext connectionContext) {
239 final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
240 LOG.debug("auxiliary connection dropped: {}, nodeId:{}", connectionContext.getConnectionAdapter()
241 .getRemoteAddress(), getDeviceInfo().getLOGValue());
242 auxiliaryConnectionContexts.remove(connectionDistinguisher);
246 public DeviceState getDeviceState() {
251 public ReadOnlyTransaction getReadTransaction() {
252 return dataBroker.newReadOnlyTransaction();
256 public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
257 final InstanceIdentifier<T> path,
260 transactionChainManager.writeToTransaction(store, path, data, false);
265 public <T extends DataObject> void writeToTransactionWithParentsSlow(final LogicalDatastoreType store,
266 final InstanceIdentifier<T> path,
269 transactionChainManager.writeToTransaction(store, path, data, true);
274 public <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path) {
276 transactionChainManager.addDeleteOperationTotTxChain(store, path);
281 public boolean submitTransaction() {
282 return initialized && transactionChainManager.submitWriteTransaction();
286 public ConnectionContext getPrimaryConnectionContext() {
287 return primaryConnectionContext;
291 public ConnectionContext getAuxiliaryConnectionContexts(final BigInteger cookie) {
292 return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
296 public DeviceFlowRegistry getDeviceFlowRegistry() {
297 return deviceFlowRegistry;
301 public DeviceGroupRegistry getDeviceGroupRegistry() {
302 return deviceGroupRegistry;
306 public DeviceMeterRegistry getDeviceMeterRegistry() {
307 return deviceMeterRegistry;
311 public void processReply(final OfHeader ofHeader) {
312 messageSpy.spyMessage(
313 ofHeader.getImplementedInterface(),
314 (ofHeader instanceof Error)
315 ? MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE
316 : MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
320 public void processReply(final Xid xid, final List<? extends OfHeader> ofHeaderList) {
321 ofHeaderList.forEach(header -> messageSpy.spyMessage(
322 header.getImplementedInterface(),
323 (header instanceof Error)
324 ? MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE
325 : MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS));
329 public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
330 //1. translate to general flow (table, priority, match, cookie)
331 final org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved flowRemovedNotification =
332 flowRemovedTranslator.translate(flowRemoved, deviceInfo, null);
334 if(myManager.isFlowRemovedNotificationOn()) {
335 // Trigger off a notification
336 notificationPublishService.offerNotification(flowRemovedNotification);
337 } else if(LOG.isDebugEnabled()) {
338 LOG.debug("For nodeId={} isNotificationFlowRemovedOn={}", getDeviceInfo().getLOGValue(), myManager.isFlowRemovedNotificationOn());
341 final ItemLifecycleListener itemLifecycleListener = flowLifeCycleKeeper.getItemLifecycleListener();
342 if (itemLifecycleListener != null) {
343 //2. create registry key
344 final FlowRegistryKey flowRegKey = FlowRegistryKeyFactory.create(getDeviceInfo().getVersion(), flowRemovedNotification);
346 final FlowDescriptor flowDescriptor = deviceFlowRegistry.retrieveDescriptor(flowRegKey);
347 //4. if flowId present:
348 if (flowDescriptor != null) {
349 // a) construct flow path
350 final KeyedInstanceIdentifier<Flow, FlowKey> flowPath = getDeviceInfo().getNodeInstanceIdentifier()
351 .augmentation(FlowCapableNode.class)
352 .child(Table.class, flowDescriptor.getTableKey())
353 .child(Flow.class, new FlowKey(flowDescriptor.getFlowId()));
354 // b) notify listener
355 itemLifecycleListener.onRemoved(flowPath);
357 LOG.debug("flow id not found: nodeId={} tableId={}, priority={}",
358 getDeviceInfo().getNodeId(), flowRegKey.getTableId(), flowRemovedNotification.getPriority());
364 public void processPortStatusMessage(final PortStatusMessage portStatus) {
365 messageSpy.spyMessage(portStatus.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
369 writePortStatusMessage(portStatus);
371 } catch (final Exception e) {
372 LOG.warn("Error processing port status message for port {} on device {}",
373 portStatus.getPortNo(), getDeviceInfo().getLOGValue(), e);
375 } else if (!hasState) {
376 primaryConnectionContext.handlePortStatusMessage(portStatus);
380 private void writePortStatusMessage(final PortStatus portStatusMessage) {
381 final FlowCapableNodeConnector flowCapableNodeConnector = portStatusTranslator
382 .translate(portStatusMessage, getDeviceInfo(), null);
384 final KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> iiToNodeConnector = getDeviceInfo()
385 .getNodeInstanceIdentifier()
386 .child(NodeConnector.class, new NodeConnectorKey(InventoryDataServiceUtil
387 .nodeConnectorIdfromDatapathPortNo(
388 deviceInfo.getDatapathId(),
389 portStatusMessage.getPortNo(),
390 OpenflowVersion.get(deviceInfo.getVersion()))));
392 if (PortReason.OFPPRADD.equals(portStatusMessage.getReason()) || PortReason.OFPPRMODIFY.equals(portStatusMessage.getReason())) {
393 // because of ADD status node connector has to be created
394 writeToTransaction(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector, new NodeConnectorBuilder()
395 .setKey(iiToNodeConnector.getKey())
396 .addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build())
397 .addAugmentation(FlowCapableNodeConnector.class, flowCapableNodeConnector)
399 } else if (PortReason.OFPPRDELETE.equals(portStatusMessage.getReason())) {
400 addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector);
405 public void processPacketInMessage(final PacketInMessage packetInMessage) {
406 messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH);
407 final ConnectionAdapter connectionAdapter = getPrimaryConnectionContext().getConnectionAdapter();
408 final PacketReceived packetReceived = packetInTranslator.translate(packetInMessage, getDeviceInfo(), null);
410 if (packetReceived == null) {
411 LOG.debug("Received a null packet from switch {}", connectionAdapter.getRemoteAddress());
412 messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_SRC_FAILURE);
415 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_OUT_SUCCESS);
418 if (!packetInLimiter.acquirePermit()) {
419 LOG.debug("Packet limited");
420 // TODO: save packet into emergency slot if possible
421 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PACKET_IN_LIMIT_REACHED_AND_DROPPED);
425 final ListenableFuture<?> offerNotification = notificationPublishService.offerNotification(packetReceived);
426 if (NotificationPublishService.REJECTED.equals(offerNotification)) {
427 LOG.debug("notification offer rejected");
428 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
429 packetInLimiter.drainLowWaterMark();
430 packetInLimiter.releasePermit();
434 Futures.addCallback(offerNotification, new FutureCallback<Object>() {
436 public void onSuccess(final Object result) {
437 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
438 packetInLimiter.releasePermit();
442 public void onFailure(final Throwable t) {
443 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
444 LOG.debug("notification offer failed: {}", t.getMessage());
445 LOG.trace("notification offer failed..", t);
446 packetInLimiter.releasePermit();
452 public void processExperimenterMessage(final ExperimenterMessage notification) {
454 final ExperimenterDataOfChoice vendorData = notification.getExperimenterDataOfChoice();
455 final MessageTypeKey<? extends ExperimenterDataOfChoice> key = new MessageTypeKey<>(
456 getDeviceInfo().getVersion(),
457 (Class<? extends ExperimenterDataOfChoice>) vendorData.getImplementedInterface());
458 final ConvertorMessageFromOFJava<ExperimenterDataOfChoice, MessagePath> messageConverter = extensionConverterProvider.getMessageConverter(key);
459 if (messageConverter == null) {
460 LOG.warn("custom converter for {}[OF:{}] not found",
461 notification.getExperimenterDataOfChoice().getImplementedInterface(),
462 getDeviceInfo().getVersion());
465 // build notification
466 final ExperimenterMessageOfChoice messageOfChoice;
468 messageOfChoice = messageConverter.convert(vendorData, MessagePath.MESSAGE_NOTIFICATION);
469 final ExperimenterMessageFromDevBuilder experimenterMessageFromDevBld = new ExperimenterMessageFromDevBuilder()
470 .setNode(new NodeRef(getDeviceInfo().getNodeInstanceIdentifier()))
471 .setExperimenterMessageOfChoice(messageOfChoice);
473 notificationPublishService.offerNotification(experimenterMessageFromDevBld.build());
474 } catch (final ConversionException e) {
475 LOG.error("Conversion of experimenter notification failed", e);
480 public TranslatorLibrary oook() {
481 return translatorLibrary;
485 public void setCurrentBarrierTimeout(final Timeout timeout) {
486 barrierTaskTimeout = timeout;
490 public Timeout getBarrierTaskTimeout() {
491 return barrierTaskTimeout;
495 public void setNotificationPublishService(final NotificationPublishService notificationPublishService) {
496 this.notificationPublishService = notificationPublishService;
500 public MessageSpy getMessageSpy() {
505 public void onPublished() {
506 Verify.verify(CONTEXT_STATE.INITIALIZATION.equals(getState()));
507 this.state = CONTEXT_STATE.WORKING;
508 primaryConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
512 public <T extends OfHeader> MultiMsgCollector<T> getMultiMsgCollector(final RequestContext<List<T>> requestContext) {
513 return new MultiMsgCollectorImpl<>(this, requestContext);
517 public void updatePacketInRateLimit(final long upperBound) {
518 packetInLimiter.changeWaterMarks((int) (LOW_WATERMARK_FACTOR * upperBound), (int) (HIGH_WATERMARK_FACTOR * upperBound));
522 public ItemLifeCycleRegistry getItemLifeCycleSourceRegistry() {
523 return itemLifeCycleSourceRegistry;
527 public void setExtensionConverterProvider(final ExtensionConverterProvider extensionConverterProvider) {
528 this.extensionConverterProvider = extensionConverterProvider;
532 public ExtensionConverterProvider getExtensionConverterProvider() {
533 return extensionConverterProvider;
537 public synchronized void shutdownConnection() {
538 if (LOG.isDebugEnabled()) {
539 LOG.debug("Shutdown method for node {}", getDeviceInfo().getLOGValue());
541 if (CONTEXT_STATE.TERMINATION.equals(getState())) {
542 LOG.debug("DeviceCtx for Node {} is in termination process.", getDeviceInfo().getLOGValue());
546 if (ConnectionContext.CONNECTION_STATE.RIP.equals(getPrimaryConnectionContext().getConnectionState())) {
547 LOG.debug("ConnectionCtx for Node {} is in RIP state.", getDeviceInfo().getLOGValue());
551 // Terminate Auxiliary Connection
552 for (final ConnectionContext connectionContext : auxiliaryConnectionContexts.values()) {
553 LOG.debug("Closing auxiliary connection {}", connectionContext.getNodeId());
554 connectionContext.closeConnection(false);
557 // Terminate Primary Connection
558 getPrimaryConnectionContext().closeConnection(true);
560 // Close all datastore registries
562 deviceGroupRegistry.close();
563 deviceFlowRegistry.close();
564 deviceMeterRegistry.close();
569 public ListenableFuture<Void> shuttingDownDataStoreTransactions() {
571 ? this.transactionChainManager.shuttingDown()
572 : Futures.immediateFuture(null);
576 TransactionChainManager getTransactionChainManager() {
577 return this.transactionChainManager;
581 public void setSwitchFeaturesMandatory(boolean switchFeaturesMandatory) {
582 this.switchFeaturesMandatory = switchFeaturesMandatory;
586 public CONTEXT_STATE getState() {
591 public ListenableFuture<Void> stopClusterServices() {
593 ? transactionChainManager.deactivateTransactionManager()
594 : Futures.immediateFuture(null);
598 public ServiceGroupIdentifier getServiceIdentifier() {
599 return this.deviceInfo.getServiceIdentifier();
603 public DeviceInfo getDeviceInfo() {
604 return this.deviceInfo;
608 public void close() {
613 public boolean canUseSingleLayerSerialization() {
614 return useSingleLayerSerialization && getDeviceInfo().getVersion() >= OFConstants.OFP_VERSION_1_3;
618 public boolean isSkipTableFeatures() {
619 return this.skipTableFeatures;
623 public void setSalRoleService(@Nonnull SalRoleService salRoleService) {
624 this.salRoleService = salRoleService;
628 public void setLifecycleInitializationPhaseHandler(final ClusterInitializationPhaseHandler handler) {
629 this.clusterInitializationPhaseHandler = handler;
633 public boolean onContextInstantiateService(final MastershipChangeListener mastershipChangeListener) {
635 LOG.info("Starting device context cluster services for node {}", deviceInfo.getLOGValue());
636 lazyTransactionManagerInitialization();
639 final List<PortStatusMessage> portStatusMessages = primaryConnectionContext
640 .retrieveAndClearPortStatusMessages();
642 portStatusMessages.forEach(this::writePortStatusMessage);
644 } catch (final Exception ex) {
645 LOG.warn("Error processing port status messages from device {}", getDeviceInfo().getLOGValue(), ex);
650 final java.util.Optional<AbstractDeviceInitializer> initializer = deviceInitializerProvider
651 .lookup(deviceInfo.getVersion());
653 if (initializer.isPresent()) {
656 .initialize(this, switchFeaturesMandatory, writerProvider, convertorExecutor)
657 .get(DEVICE_INIT_TIMEOUT, TimeUnit.MILLISECONDS);
659 throw new ExecutionException(new ConnectionException("Unsupported version " + deviceInfo.getVersion()));
661 } catch (ExecutionException | InterruptedException | TimeoutException ex) {
662 LOG.warn("Device {} cannot be initialized: ", deviceInfo.getLOGValue(), ex);
666 Futures.addCallback(sendRoleChangeToDevice(OfpRole.BECOMEMASTER),
667 new RpcResultFutureCallback(mastershipChangeListener));
669 final ListenableFuture<List<Optional<FlowCapableNode>>> deviceFlowRegistryFill = getDeviceFlowRegistry().fill();
670 Futures.addCallback(deviceFlowRegistryFill,
671 new DeviceFlowRegistryCallback(deviceFlowRegistryFill, mastershipChangeListener));
673 return this.clusterInitializationPhaseHandler.onContextInstantiateService(mastershipChangeListener);
677 void lazyTransactionManagerInitialization() {
678 if (!this.initialized) {
679 if (LOG.isDebugEnabled()) {
680 LOG.debug("Transaction chain manager for node {} created", deviceInfo.getLOGValue());
682 this.transactionChainManager = new TransactionChainManager(dataBroker, deviceInfo);
683 this.deviceFlowRegistry = new DeviceFlowRegistryImpl(deviceInfo.getVersion(), dataBroker, deviceInfo.getNodeInstanceIdentifier());
684 this.deviceGroupRegistry = new DeviceGroupRegistryImpl();
685 this.deviceMeterRegistry = new DeviceMeterRegistryImpl();
686 this.transactionChainManager.activateTransactionManager();
687 this.initialized = true;
693 public <T> RequestContext<T> createRequestContext() {
694 return new AbstractRequestContext<T>(deviceInfo.reserveXidForDeviceMessage()) {
696 public void close() {
702 private ListenableFuture<RpcResult<SetRoleOutput>> sendRoleChangeToDevice(final OfpRole newRole) {
703 if (LOG.isDebugEnabled()) {
704 LOG.debug("Sending new role {} to device {}", newRole, deviceInfo.getNodeId());
707 final Future<RpcResult<SetRoleOutput>> setRoleOutputFuture;
709 if (deviceInfo.getVersion() >= OFConstants.OFP_VERSION_1_3) {
710 final SetRoleInput setRoleInput = (new SetRoleInputBuilder()).setControllerRole(newRole)
711 .setNode(new NodeRef(deviceInfo.getNodeInstanceIdentifier())).build();
713 setRoleOutputFuture = this.salRoleService.setRole(setRoleInput);
715 final TimerTask timerTask = timeout -> {
716 if (!setRoleOutputFuture.isDone()) {
717 LOG.warn("New role {} was not propagated to device {} during {} sec", newRole, deviceInfo.getLOGValue(), SET_ROLE_TIMEOUT);
718 setRoleOutputFuture.cancel(true);
722 hashedWheelTimer.newTimeout(timerTask, SET_ROLE_TIMEOUT, TimeUnit.SECONDS);
724 LOG.info("Device: {} with version: {} does not support role", deviceInfo.getLOGValue(), deviceInfo.getVersion());
725 return Futures.immediateFuture(null);
728 return JdkFutureAdapters.listenInPoolThread(setRoleOutputFuture);
732 public ListenableFuture<RpcResult<SetRoleOutput>> makeDeviceSlave() {
733 return sendRoleChangeToDevice(OfpRole.BECOMESLAVE);
737 public void onStateAcquired(final ContextChainState state) {
741 private class RpcResultFutureCallback implements FutureCallback<RpcResult<SetRoleOutput>> {
743 private final MastershipChangeListener mastershipChangeListener;
745 RpcResultFutureCallback(final MastershipChangeListener mastershipChangeListener) {
746 this.mastershipChangeListener = mastershipChangeListener;
750 public void onSuccess(@Nullable RpcResult<SetRoleOutput> setRoleOutputRpcResult) {
751 this.mastershipChangeListener.onMasterRoleAcquired(
753 ContextChainMastershipState.MASTER_ON_DEVICE
755 if (LOG.isDebugEnabled()) {
756 LOG.debug("Role MASTER was successfully set on device, node {}", deviceInfo.getLOGValue());
761 public void onFailure(final Throwable throwable) {
762 mastershipChangeListener.onNotAbleToStartMastershipMandatory(
764 "Was not able to set MASTER role on device");
768 private class DeviceFlowRegistryCallback implements FutureCallback<List<Optional<FlowCapableNode>>> {
769 private final ListenableFuture<List<Optional<FlowCapableNode>>> deviceFlowRegistryFill;
770 private final MastershipChangeListener mastershipChangeListener;
772 DeviceFlowRegistryCallback(
773 ListenableFuture<List<Optional<FlowCapableNode>>> deviceFlowRegistryFill,
774 MastershipChangeListener mastershipChangeListener) {
775 this.deviceFlowRegistryFill = deviceFlowRegistryFill;
776 this.mastershipChangeListener = mastershipChangeListener;
780 public void onSuccess(@Nullable List<Optional<FlowCapableNode>> result) {
781 if (LOG.isDebugEnabled()) {
782 // Count all flows we read from datastore for debugging purposes.
783 // This number do not always represent how many flows were actually added
784 // to DeviceFlowRegistry, because of possible duplicates.
785 long flowCount = Optional.fromNullable(result).asSet().stream()
786 .flatMap(Collection::stream)
787 .filter(Objects::nonNull)
788 .flatMap(flowCapableNodeOptional -> flowCapableNodeOptional.asSet().stream())
789 .filter(Objects::nonNull)
790 .filter(flowCapableNode -> Objects.nonNull(flowCapableNode.getTable()))
791 .flatMap(flowCapableNode -> flowCapableNode.getTable().stream())
792 .filter(Objects::nonNull)
793 .filter(table -> Objects.nonNull(table.getFlow()))
794 .flatMap(table -> table.getFlow().stream())
795 .filter(Objects::nonNull)
798 LOG.debug("Finished filling flow registry with {} flows for node: {}", flowCount, deviceInfo.getLOGValue());
800 this.mastershipChangeListener.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.INITIAL_FLOW_REGISTRY_FILL);
804 public void onFailure(Throwable t) {
805 if (deviceFlowRegistryFill.isCancelled()) {
806 if (LOG.isDebugEnabled()) {
807 LOG.debug("Cancelled filling flow registry with flows for node: {}", deviceInfo.getLOGValue());
810 LOG.warn("Failed filling flow registry with flows for node: {} with exception: {}", deviceInfo.getLOGValue(), t);
812 mastershipChangeListener.onNotAbleToStartMastership(
814 "Was not able to fill flow registry on device",