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.util.concurrent.FutureCallback;
13 import com.google.common.util.concurrent.Futures;
14 import com.google.common.util.concurrent.ListenableFuture;
15 import io.netty.util.HashedWheelTimer;
16 import io.netty.util.Timeout;
17 import java.math.BigInteger;
18 import java.util.Collection;
19 import java.util.HashMap;
20 import java.util.HashSet;
21 import java.util.List;
23 import java.util.concurrent.ConcurrentHashMap;
24 import javax.annotation.Nonnull;
25 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
26 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
27 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
28 import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
29 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
30 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
31 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
32 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
33 import org.opendaylight.openflowplugin.api.openflow.connection.OutboundQueueProvider;
34 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
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.DeviceContextClosedHandler;
41 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
42 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
43 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
44 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
45 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
46 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowDescriptor;
47 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowRegistryKey;
48 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
49 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
50 import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleKeeper;
51 import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
52 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
53 import org.opendaylight.openflowplugin.impl.common.ItemLifeCycleSourceImpl;
54 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
55 import org.opendaylight.openflowplugin.impl.device.listener.MultiMsgCollectorImpl;
56 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
57 import org.opendaylight.openflowplugin.impl.registry.flow.FlowRegistryKeyFactory;
58 import org.opendaylight.openflowplugin.impl.registry.group.DeviceGroupRegistryImpl;
59 import org.opendaylight.openflowplugin.impl.registry.meter.DeviceMeterRegistryImpl;
60 import org.opendaylight.openflowplugin.openflow.md.core.session.SwitchConnectionCookieOFImpl;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortReason;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketIn;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
84 import org.opendaylight.yangtools.yang.binding.ChildOf;
85 import org.opendaylight.yangtools.yang.binding.DataObject;
86 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
87 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
88 import org.slf4j.Logger;
89 import org.slf4j.LoggerFactory;
94 public class DeviceContextImpl implements DeviceContext {
96 private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
98 // TODO: drain factor should be parametrized
99 public static final float REJECTED_DRAIN_FACTOR = 0.25f;
100 // TODO: low water mark factor should be parametrized
101 private static final float LOW_WATERMARK_FACTOR = 0.75f;
102 // TODO: high water mark factor should be parametrized
103 private static final float HIGH_WATERMARK_FACTOR = 0.95f;
105 private final ConnectionContext primaryConnectionContext;
106 private final DeviceState deviceState;
107 private final DataBroker dataBroker;
108 private final HashedWheelTimer hashedWheelTimer;
109 private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
110 private final TransactionChainManager transactionChainManager;
111 private final DeviceFlowRegistry deviceFlowRegistry;
112 private final DeviceGroupRegistry deviceGroupRegistry;
113 private final DeviceMeterRegistry deviceMeterRegistry;
114 private final Collection<DeviceContextClosedHandler> closeHandlers = new HashSet<>();
115 private final PacketInRateLimiter packetInLimiter;
116 private final MessageSpy messageSpy;
117 private final ItemLifeCycleKeeper flowLifeCycleKeeper;
118 private NotificationPublishService notificationPublishService;
119 private NotificationService notificationService;
120 private final OutboundQueue outboundQueueProvider;
121 private Timeout barrierTaskTimeout;
122 private final MessageTranslator<PortGrouping, FlowCapableNodeConnector> portStatusTranslator;
123 private final MessageTranslator<PacketInMessage, PacketReceived> packetInTranslator;
124 private final MessageTranslator<FlowRemoved, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved> flowRemovedTranslator;
125 private final TranslatorLibrary translatorLibrary;
126 private Map<Long, NodeConnectorRef> nodeConnectorCache;
127 private ItemLifeCycleRegistry itemLifeCycleSourceRegistry;
131 DeviceContextImpl(@Nonnull final ConnectionContext primaryConnectionContext,
132 @Nonnull final DeviceState deviceState,
133 @Nonnull final DataBroker dataBroker,
134 @Nonnull final HashedWheelTimer hashedWheelTimer,
135 @Nonnull final MessageSpy _messageSpy,
136 @Nonnull final OutboundQueueProvider outboundQueueProvider,
137 @Nonnull final TranslatorLibrary translatorLibrary,
138 @Nonnull final TransactionChainManager transactionChainManager) {
139 this.primaryConnectionContext = Preconditions.checkNotNull(primaryConnectionContext);
140 this.deviceState = Preconditions.checkNotNull(deviceState);
141 this.dataBroker = Preconditions.checkNotNull(dataBroker);
142 this.hashedWheelTimer = Preconditions.checkNotNull(hashedWheelTimer);
143 this.outboundQueueProvider = Preconditions.checkNotNull(outboundQueueProvider);
144 this.transactionChainManager = Preconditions.checkNotNull(transactionChainManager);
145 auxiliaryConnectionContexts = new HashMap<>();
146 deviceFlowRegistry = new DeviceFlowRegistryImpl();
147 deviceGroupRegistry = new DeviceGroupRegistryImpl();
148 deviceMeterRegistry = new DeviceMeterRegistryImpl();
149 messageSpy = _messageSpy;
151 packetInLimiter = new PacketInRateLimiter(primaryConnectionContext.getConnectionAdapter(),
152 /*initial*/ 1000, /*initial*/2000, messageSpy, REJECTED_DRAIN_FACTOR);
154 this.translatorLibrary = translatorLibrary;
155 portStatusTranslator = translatorLibrary.lookupTranslator(
156 new TranslatorKey(deviceState.getVersion(), PortGrouping.class.getName()));
157 packetInTranslator = translatorLibrary.lookupTranslator(
158 new TranslatorKey(deviceState.getVersion(), PacketIn.class.getName()));
159 flowRemovedTranslator = translatorLibrary.lookupTranslator(
160 new TranslatorKey(deviceState.getVersion(), FlowRemoved.class.getName()));
163 nodeConnectorCache = new ConcurrentHashMap<>();
165 itemLifeCycleSourceRegistry = new ItemLifeCycleRegistryImpl();
166 flowLifeCycleKeeper = new ItemLifeCycleSourceImpl();
167 itemLifeCycleSourceRegistry.registerLifeCycleSource(flowLifeCycleKeeper);
171 * This method is called from {@link DeviceManagerImpl} only. So we could say "posthandshake process finish"
172 * and we are able to set a scheduler for an automatic transaction submitting by time (0,5sec).
174 void initialSubmitTransaction() {
175 transactionChainManager.initialSubmitWriteTransaction();
179 public Long getReservedXid() {
180 return outboundQueueProvider.reserveEntry();
184 public <M extends ChildOf<DataObject>> void onMessage(final M message, final RequestContext<?> requestContext) {
185 // TODO Auto-generated method stub
189 public void addAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
190 final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
191 auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
194 private static SwitchConnectionDistinguisher createConnectionDistinguisher(final ConnectionContext connectionContext) {
195 return new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
199 public void removeAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
200 // TODO Auto-generated method stub
204 public DeviceState getDeviceState() {
209 public ReadTransaction getReadTransaction() {
210 return dataBroker.newReadOnlyTransaction();
214 public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
215 final InstanceIdentifier<T> path, final T data) {
216 transactionChainManager.writeToTransaction(store, path, data);
220 public <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path) {
221 transactionChainManager.addDeleteOperationTotTxChain(store, path);
225 public boolean submitTransaction() {
226 return transactionChainManager.submitWriteTransaction();
230 public ConnectionContext getPrimaryConnectionContext() {
231 return primaryConnectionContext;
235 public ConnectionContext getAuxiliaryConnectiobContexts(final BigInteger cookie) {
236 return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
240 public DeviceFlowRegistry getDeviceFlowRegistry() {
241 return deviceFlowRegistry;
245 public DeviceGroupRegistry getDeviceGroupRegistry() {
246 return deviceGroupRegistry;
250 public DeviceMeterRegistry getDeviceMeterRegistry() {
251 return deviceMeterRegistry;
255 public void processReply(final OfHeader ofHeader) {
256 if (ofHeader instanceof Error) {
257 messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
259 messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
264 public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
265 for (final MultipartReply multipartReply : ofHeaderList) {
266 messageSpy.spyMessage(multipartReply.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
271 public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
272 final ItemLifecycleListener itemLifecycleListener = flowLifeCycleKeeper.getItemLifecycleListener();
273 if (itemLifecycleListener != null) {
274 //1. translate to general flow (table, priority, match, cookie)
275 final org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved flowRemovedNotification =
276 flowRemovedTranslator.translate(flowRemoved, this, null);
277 //2. create registry key
278 FlowRegistryKey flowRegKey = FlowRegistryKeyFactory.create(flowRemovedNotification);
280 final FlowDescriptor flowDescriptor = deviceFlowRegistry.retrieveIdForFlow(flowRegKey);
281 //4. if flowId present:
282 if (flowDescriptor != null) {
283 // a) construct flow path
284 KeyedInstanceIdentifier<Flow, FlowKey> flowPath = getDeviceState().getNodeInstanceIdentifier()
285 .augmentation(FlowCapableNode.class)
286 .child(Table.class, flowDescriptor.getTableKey())
287 .child(Flow.class, new FlowKey(flowDescriptor.getFlowId()));
288 // b) notify listener
289 itemLifecycleListener.onRemoved(flowPath);
291 LOG.debug("flow id not found: nodeId={} tableId={}, priority={}",
292 getDeviceState().getNodeId(), flowRegKey.getTableId(), flowRemovedNotification.getPriority());
298 public void processPortStatusMessage(final PortStatusMessage portStatus) {
299 messageSpy.spyMessage(portStatus.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
300 final FlowCapableNodeConnector flowCapableNodeConnector = portStatusTranslator.translate(portStatus, this, null);
302 final KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> iiToNodeConnector = provideIIToNodeConnector(portStatus.getPortNo(), portStatus.getVersion());
303 if (portStatus.getReason().equals(PortReason.OFPPRADD) || portStatus.getReason().equals(PortReason.OFPPRMODIFY)) {
304 // because of ADD status node connector has to be created
305 final NodeConnectorBuilder nConnectorBuilder = new NodeConnectorBuilder().setKey(iiToNodeConnector.getKey());
306 nConnectorBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
307 nConnectorBuilder.addAugmentation(FlowCapableNodeConnector.class, flowCapableNodeConnector);
308 writeToTransaction(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector, nConnectorBuilder.build());
309 } else if (portStatus.getReason().equals(PortReason.OFPPRDELETE)) {
310 addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector);
315 private KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> provideIIToNodeConnector(final long portNo, final short version) {
316 final InstanceIdentifier<Node> iiToNodes = deviceState.getNodeInstanceIdentifier();
317 final BigInteger dataPathId = deviceState.getFeatures().getDatapathId();
318 final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), portNo, version);
319 return iiToNodes.child(NodeConnector.class, new NodeConnectorKey(nodeConnectorId));
323 public void processPacketInMessage(final PacketInMessage packetInMessage) {
324 messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH);
325 final ConnectionAdapter connectionAdapter = getPrimaryConnectionContext().getConnectionAdapter();
326 final PacketReceived packetReceived = packetInTranslator.translate(packetInMessage, this, null);
328 if (packetReceived == null) {
329 LOG.debug("Received a null packet from switch {}", connectionAdapter.getRemoteAddress());
333 if (!packetInLimiter.acquirePermit()) {
334 LOG.debug("Packet limited");
335 // TODO: save packet into emergency slot if possible
336 // FIXME: some other counter
337 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_SRC_FAILURE);
341 final ListenableFuture<? extends Object> offerNotification = notificationPublishService.offerNotification(packetReceived);
342 if (NotificationPublishService.REJECTED.equals(offerNotification)) {
343 LOG.debug("notification offer rejected");
344 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_SRC_FAILURE);
345 packetInLimiter.drainLowWaterMark();
346 packetInLimiter.releasePermit();
350 Futures.addCallback(offerNotification, new FutureCallback<Object>() {
352 public void onSuccess(final Object result) {
353 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
354 packetInLimiter.releasePermit();
358 public void onFailure(final Throwable t) {
359 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
360 LOG.debug("notification offer failed: {}", t.getMessage());
361 LOG.trace("notification offer failed..", t);
362 packetInLimiter.releasePermit();
368 public TranslatorLibrary oook() {
369 return translatorLibrary;
373 public HashedWheelTimer getTimer() {
374 return hashedWheelTimer;
378 public void close() {
379 LOG.debug("closing deviceContext: {}, nodeId:{}",
380 getPrimaryConnectionContext().getConnectionAdapter().getRemoteAddress(),
381 getDeviceState().getNodeId());
385 primaryConnectionContext.closeConnection(false);
388 private void tearDown() {
389 deviceState.setValid(false);
391 for (final ConnectionContext connectionContext : auxiliaryConnectionContexts.values()) {
392 connectionContext.closeConnection(false);
395 deviceGroupRegistry.close();
396 deviceFlowRegistry.close();
397 deviceMeterRegistry.close();
399 itemLifeCycleSourceRegistry.clear();
402 for (final DeviceContextClosedHandler deviceContextClosedHandler : closeHandlers) {
403 deviceContextClosedHandler.onDeviceContextClosed(this);
406 transactionChainManager.close();
410 public void onDeviceDisconnected(final ConnectionContext connectionContext) {
411 if (getPrimaryConnectionContext().equals(connectionContext)) {
414 } catch (final Exception e) {
415 LOG.trace("Error closing device context.");
418 LOG.debug("auxiliary connection dropped: {}, nodeId:{}",
419 connectionContext.getConnectionAdapter().getRemoteAddress(),
420 getDeviceState().getNodeId());
421 final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
422 auxiliaryConnectionContexts.remove(connectionDistinguisher);
427 public void setCurrentBarrierTimeout(final Timeout timeout) {
428 barrierTaskTimeout = timeout;
432 public Timeout getBarrierTaskTimeout() {
433 return barrierTaskTimeout;
437 public void setNotificationService(final NotificationService notificationServiceParam) {
438 notificationService = notificationServiceParam;
442 public void setNotificationPublishService(final NotificationPublishService notificationPublishService) {
443 this.notificationPublishService = notificationPublishService;
447 public MessageSpy getMessageSpy() {
452 public void addDeviceContextClosedHandler(final DeviceContextClosedHandler deviceContextClosedHandler) {
453 closeHandlers.add(deviceContextClosedHandler);
457 public void onPublished() {
458 primaryConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
459 for (final ConnectionContext switchAuxConnectionContext : auxiliaryConnectionContexts.values()) {
460 switchAuxConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
465 public MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext) {
466 return new MultiMsgCollectorImpl(this, requestContext);
470 public NodeConnectorRef lookupNodeConnectorRef(Long portNumber) {
471 return nodeConnectorCache.get(portNumber);
475 public void storeNodeConnectorRef(final Long portNumber, final NodeConnectorRef nodeConnectorRef) {
476 nodeConnectorCache.put(
477 Preconditions.checkNotNull(portNumber),
478 Preconditions.checkNotNull(nodeConnectorRef));
482 public void updatePacketInRateLimit(long upperBound) {
483 packetInLimiter.changeWaterMarks((int) (LOW_WATERMARK_FACTOR * upperBound), (int) (HIGH_WATERMARK_FACTOR * upperBound));
487 public ItemLifeCycleRegistry getItemLifeCycleSourceRegistry() {
488 return itemLifeCycleSourceRegistry;