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.SettableFuture;
13 import io.netty.util.HashedWheelTimer;
14 import io.netty.util.Timeout;
15 import java.math.BigInteger;
16 import java.util.ArrayList;
17 import java.util.HashMap;
18 import java.util.Iterator;
19 import java.util.List;
21 import java.util.TreeMap;
22 import java.util.concurrent.atomic.AtomicLong;
23 import javax.annotation.Nonnull;
24 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
25 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
26 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
27 import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
28 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
29 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
30 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
31 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
32 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
33 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
34 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
35 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
36 import org.opendaylight.openflowplugin.api.openflow.device.exception.DeviceDataException;
37 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceContextClosedHandler;
38 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceDisconnectedHandler;
39 import org.opendaylight.openflowplugin.api.openflow.device.listener.OpenflowMessageListenerFacade;
40 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
41 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
42 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
43 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
44 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
45 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
46 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
47 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
48 import org.opendaylight.openflowplugin.impl.registry.group.DeviceGroupRegistryImpl;
49 import org.opendaylight.openflowplugin.impl.registry.meter.DeviceMeterRegistryImpl;
50 import org.opendaylight.openflowplugin.impl.services.RequestContextUtil;
51 import org.opendaylight.openflowplugin.openflow.md.core.session.SwitchConnectionCookieOFImpl;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortReason;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketIn;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
70 import org.opendaylight.yangtools.yang.binding.ChildOf;
71 import org.opendaylight.yangtools.yang.binding.DataObject;
72 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
73 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
74 import org.opendaylight.yangtools.yang.common.RpcError;
75 import org.opendaylight.yangtools.yang.common.RpcResult;
76 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
77 import org.slf4j.Logger;
78 import org.slf4j.LoggerFactory;
83 public class DeviceContextImpl implements DeviceContext {
85 private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
86 public static final String DEVICE_DISCONNECTED = "Device disconnected.";
88 private final ConnectionContext primaryConnectionContext;
89 private final DeviceState deviceState;
90 private final DataBroker dataBroker;
91 private final XidGenerator xidGenerator;
92 private final HashedWheelTimer hashedWheelTimer;
93 private Map<Long, RequestContext> requests = new TreeMap();
95 private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
96 private final TransactionChainManager txChainManager;
97 private TranslatorLibrary translatorLibrary;
98 private OpenflowMessageListenerFacade openflowMessageListenerFacade;
99 private final DeviceFlowRegistry deviceFlowRegistry;
100 private final DeviceGroupRegistry deviceGroupRegistry;
101 private final DeviceMeterRegistry deviceMeterRegistry;
102 private Timeout barrierTaskTimeout;
103 private NotificationService notificationService;
104 private final MessageSpy<Class> messageSpy;
105 private DeviceDisconnectedHandler deviceDisconnectedHandler;
106 private List<DeviceContextClosedHandler> closeHandlers = new ArrayList<>();
107 private NotificationPublishService notificationPublishService;
111 DeviceContextImpl(@Nonnull final ConnectionContext primaryConnectionContext,
112 @Nonnull final DeviceState deviceState,
113 @Nonnull final DataBroker dataBroker,
114 @Nonnull final HashedWheelTimer hashedWheelTimer,
115 @Nonnull final MessageSpy _messageSpy) {
116 this.primaryConnectionContext = Preconditions.checkNotNull(primaryConnectionContext);
117 this.deviceState = Preconditions.checkNotNull(deviceState);
118 this.dataBroker = Preconditions.checkNotNull(dataBroker);
119 this.hashedWheelTimer = Preconditions.checkNotNull(hashedWheelTimer);
120 xidGenerator = new XidGenerator();
121 txChainManager = new TransactionChainManager(dataBroker, hashedWheelTimer, 500L, 500L);
122 auxiliaryConnectionContexts = new HashMap<>();
123 deviceFlowRegistry = new DeviceFlowRegistryImpl();
124 deviceGroupRegistry = new DeviceGroupRegistryImpl();
125 deviceMeterRegistry = new DeviceMeterRegistryImpl();
126 messageSpy = _messageSpy;
130 * This method is called from {@link DeviceManagerImpl} only. So we could say "posthandshake process finish"
131 * and we are able to set a scheduler for an automatic transaction submitting by time (0,5sec).
133 void submitTransaction() {
134 txChainManager.enableSubmit();
135 txChainManager.submitTransaction();
139 public <M extends ChildOf<DataObject>> void onMessage(final M message, final RequestContext requestContext) {
140 // TODO Auto-generated method stub
145 public void addAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
146 final SwitchConnectionDistinguisher connectionDistinguisher = new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
147 auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
151 public void removeAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
152 // TODO Auto-generated method stub
156 public DeviceState getDeviceState() {
161 public ReadTransaction getReadTransaction() {
162 return dataBroker.newReadOnlyTransaction();
166 public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
167 final InstanceIdentifier<T> path, final T data) {
168 txChainManager.writeToTransaction(store, path, data);
172 public <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path) {
173 txChainManager.addDeleteOperationTotTxChain(store, path);
177 public ConnectionContext getPrimaryConnectionContext() {
178 return primaryConnectionContext;
182 public ConnectionContext getAuxiliaryConnectiobContexts(final BigInteger cookie) {
183 return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
187 public Xid getNextXid() {
188 return xidGenerator.generate();
192 public RequestContext lookupRequest(Xid xid) {
193 return requests.get(xid.getValue());
197 public int getNumberOfOutstandingRequests() {
198 return requests.size();
202 public void hookRequestCtx(final Xid xid, final RequestContext requestFutureContext) {
203 requests.put(xid.getValue(), requestFutureContext);
207 public RequestContext unhookRequestCtx(Xid xid) {
208 return requests.remove(xid.getValue());
212 public void attachOpenflowMessageListener(final OpenflowMessageListenerFacade openflowMessageListenerFacade) {
213 this.openflowMessageListenerFacade = openflowMessageListenerFacade;
214 primaryConnectionContext.getConnectionAdapter().setMessageListener(openflowMessageListenerFacade);
218 public OpenflowMessageListenerFacade getOpenflowMessageListenerFacade() {
219 return openflowMessageListenerFacade;
223 public DeviceFlowRegistry getDeviceFlowRegistry() {
224 return deviceFlowRegistry;
228 public DeviceGroupRegistry getDeviceGroupRegistry() {
229 return deviceGroupRegistry;
233 public DeviceMeterRegistry getDeviceMeterRegistry() {
234 return deviceMeterRegistry;
238 public void processReply(final OfHeader ofHeader) {
239 final RequestContext requestContext = requests.get(ofHeader.getXid());
240 if (null != requestContext) {
241 final SettableFuture replyFuture = requestContext.getFuture();
242 requests.remove(ofHeader.getXid());
243 RpcResult<OfHeader> rpcResult;
244 if (ofHeader instanceof Error) {
245 //TODO : this is the point, where we can discover that add flow operation failed and where we should
246 //TODO : remove this flow from deviceFlowRegistry
247 final Error error = (Error) ofHeader;
248 final String message = "Operation on device failed with xid "+ofHeader.getXid()+".";
249 rpcResult = RpcResultBuilder
251 .withError(RpcError.ErrorType.APPLICATION, message, new DeviceDataException(message, error))
253 messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
255 rpcResult = RpcResultBuilder
257 .withResult(ofHeader)
259 messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
262 replyFuture.set(rpcResult);
264 requestContext.close();
265 } catch (final Exception e) {
266 LOG.warn("Closing RequestContext failed: {}", e.getMessage());
267 LOG.debug("Closing RequestContext failed.. ", e);
270 LOG.warn("Can't find request context registered for xid : {}. Type of reply: {}. From address: {}", ofHeader.getXid(), ofHeader.getClass().getName(),
271 getPrimaryConnectionContext().getConnectionAdapter().getRemoteAddress());
276 public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
277 final RequestContext requestContext = requests.get(xid.getValue());
278 if (null != requestContext) {
279 final SettableFuture replyFuture = requestContext.getFuture();
280 requests.remove(xid.getValue());
281 final RpcResult<List<MultipartReply>> rpcResult = RpcResultBuilder
282 .<List<MultipartReply>>success()
283 .withResult(ofHeaderList)
285 replyFuture.set(rpcResult);
286 for (MultipartReply multipartReply : ofHeaderList) {
287 messageSpy.spyMessage(multipartReply.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
291 requestContext.close();
292 } catch (final Exception e) {
293 LOG.warn("Closing RequestContext failed: {}", e.getMessage());
294 LOG.debug("Closing RequestContext failed.. ", e);
297 LOG.warn("Can't find request context registered for xid : {}. Type of reply: MULTIPART. From address: {}", xid.getValue(),
298 getPrimaryConnectionContext().getConnectionAdapter().getRemoteAddress());
303 public void processException(final Xid xid, final DeviceDataException deviceDataException) {
305 LOG.trace("Processing exception for xid : {}", xid.getValue());
307 final RequestContext requestContext = requests.get(xid.getValue());
309 if (null != requestContext) {
310 final SettableFuture replyFuture = requestContext.getFuture();
311 requests.remove(xid.getValue());
312 final RpcResult<List<OfHeader>> rpcResult = RpcResultBuilder
313 .<List<OfHeader>>failed()
314 .withError(RpcError.ErrorType.APPLICATION, String.format("Message processing failed : %s", deviceDataException.getError()), deviceDataException)
316 replyFuture.set(rpcResult);
317 messageSpy.spyMessage(deviceDataException.getClass(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
319 requestContext.close();
320 } catch (final Exception e) {
321 LOG.warn("Closing RequestContext failed: ", e);
322 LOG.debug("Closing RequestContext failed..", e);
325 LOG.warn("Can't find request context registered for xid : {}. Exception message {}",
326 xid.getValue(), deviceDataException.getMessage());
331 public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
332 //TODO: will be defined later
336 public void processPortStatusMessage(final PortStatusMessage portStatus) {
337 messageSpy.spyMessage(portStatus.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
338 final TranslatorKey translatorKey = new TranslatorKey(portStatus.getVersion(), PortGrouping.class.getName());
339 final MessageTranslator<PortGrouping, FlowCapableNodeConnector> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
340 final FlowCapableNodeConnector flowCapableNodeConnector = messageTranslator.translate(portStatus, this, null);
342 final KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> iiToNodeConnector = provideIIToNodeConnector(portStatus.getPortNo(), portStatus.getVersion());
343 if (portStatus.getReason().equals(PortReason.OFPPRADD) || portStatus.getReason().equals(PortReason.OFPPRMODIFY)) {
344 // because of ADD status node connector has to be created
345 final NodeConnectorBuilder nConnectorBuilder = new NodeConnectorBuilder().setKey(iiToNodeConnector.getKey());
346 nConnectorBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
347 nConnectorBuilder.addAugmentation(FlowCapableNodeConnector.class, flowCapableNodeConnector);
348 writeToTransaction(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector, nConnectorBuilder.build());
349 } else if (portStatus.getReason().equals(PortReason.OFPPRDELETE)) {
350 addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector);
354 private KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> provideIIToNodeConnector(final long portNo, final short version) {
355 final InstanceIdentifier<Node> iiToNodes = deviceState.getNodeInstanceIdentifier();
356 final BigInteger dataPathId = deviceState.getFeatures().getDatapathId();
357 final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), portNo, version);
358 return iiToNodes.child(NodeConnector.class, new NodeConnectorKey(nodeConnectorId));
362 public void processPacketInMessage(final PacketInMessage packetInMessage) {
363 messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
364 final TranslatorKey translatorKey = new TranslatorKey(packetInMessage.getVersion(), PacketIn.class.getName());
365 final MessageTranslator<PacketInMessage, PacketReceived> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
366 final PacketReceived packetReceived = messageTranslator.translate(packetInMessage, this, null);
367 if (!notificationPublishService.offerNotification(packetReceived)){
368 LOG.debug("Notification offer refused by notification service.");
374 public TranslatorLibrary oook() {
375 return translatorLibrary;
379 public void setTranslatorLibrary(final TranslatorLibrary translatorLibrary) {
380 this.translatorLibrary = translatorLibrary;
384 public HashedWheelTimer getTimer() {
385 return hashedWheelTimer;
389 public void close() throws Exception {
390 deviceState.setValid(false);
392 LOG.trace("Removing node {} from operational DS.", getDeviceState().getNodeId());
393 addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, getDeviceState().getNodeInstanceIdentifier());
395 deviceGroupRegistry.close();
396 deviceFlowRegistry.close();
397 deviceMeterRegistry.close();
399 if (primaryConnectionContext.getConnectionAdapter().isAlive()) {
400 primaryConnectionContext.setConnectionState(ConnectionContext.CONNECTION_STATE.RIP);
401 primaryConnectionContext.getConnectionAdapter().disconnect();
403 for (Map.Entry<Long, RequestContext> entry : requests.entrySet()) {
404 RequestContextUtil.closeRequestContextWithRpcError(entry.getValue(), DEVICE_DISCONNECTED);
406 for (ConnectionContext connectionContext : auxiliaryConnectionContexts.values()) {
407 if (connectionContext.getConnectionAdapter().isAlive()) {
408 connectionContext.getConnectionAdapter().disconnect();
411 for (DeviceContextClosedHandler deviceContextClosedHandler : closeHandlers) {
412 deviceContextClosedHandler.onDeviceContextClosed(this);
418 public void onDeviceDisconnected(final ConnectionContext connectionContext) {
419 if (this.getPrimaryConnectionContext().equals(connectionContext)) {
422 } catch (Exception e) {
423 LOG.trace("Error closing device context.");
425 if (null != deviceDisconnectedHandler) {
426 deviceDisconnectedHandler.onDeviceDisconnected(connectionContext);
429 auxiliaryConnectionContexts.remove(connectionContext);
434 private class XidGenerator {
436 private final AtomicLong xid = new AtomicLong(0);
438 public Xid generate() {
439 return new Xid(xid.incrementAndGet());
444 public RequestContext extractNextOutstandingMessage(final long barrierXid) {
445 RequestContext nextMessage = null;
446 final Iterator<Long> keyIterator = requests.keySet().iterator();
447 if (keyIterator.hasNext()) {
448 final Long oldestXid = keyIterator.next();
449 if (oldestXid < barrierXid) {
450 nextMessage = requests.remove(oldestXid);
457 public void setCurrentBarrierTimeout(final Timeout timeout) {
458 barrierTaskTimeout = timeout;
462 public Timeout getBarrierTaskTimeout() {
463 return barrierTaskTimeout;
467 public void setNotificationService(final NotificationService notificationServiceParam) {
468 notificationService = notificationServiceParam;
472 public void setNotificationPublishService(final NotificationPublishService notificationPublishService) {
473 this.notificationPublishService = notificationPublishService;
477 public MessageSpy getMessageSpy() {
482 public void setDeviceDisconnectedHandler(final DeviceDisconnectedHandler deviceDisconnectedHandler) {
483 this.deviceDisconnectedHandler = deviceDisconnectedHandler;
487 public void addDeviceContextClosedHandler(final DeviceContextClosedHandler deviceContextClosedHandler) {
488 this.closeHandlers.add(deviceContextClosedHandler);
492 public void startGatheringOperationsToOneTransaction() {
493 txChainManager.startGatheringOperationsToOneTransaction();
497 public void commitOperationsGatheredInOneTransaction() {
498 txChainManager.commitOperationsGatheredInOneTransaction();