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.HashMap;
17 import java.util.Iterator;
18 import java.util.List;
20 import java.util.TreeMap;
21 import java.util.concurrent.atomic.AtomicLong;
22 import javax.annotation.Nonnull;
23 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
24 import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
25 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
26 import org.opendaylight.controller.sal.binding.api.NotificationProviderService;
27 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
28 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
29 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
30 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
31 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
32 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
33 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
34 import org.opendaylight.openflowplugin.api.openflow.device.exception.DeviceDataException;
35 import org.opendaylight.openflowplugin.api.openflow.device.listener.OpenflowMessageListenerFacade;
36 import org.opendaylight.openflowplugin.api.openflow.flow.registry.DeviceFlowRegistry;
37 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
38 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
39 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
40 import org.opendaylight.openflowplugin.impl.flow.registry.DeviceFlowRegistryImpl;
41 import org.opendaylight.openflowplugin.impl.translator.PacketReceivedTranslator;
42 import org.opendaylight.openflowplugin.openflow.md.core.session.SwitchConnectionCookieOFImpl;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortReason;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableFeatures;
61 import org.opendaylight.yangtools.yang.binding.ChildOf;
62 import org.opendaylight.yangtools.yang.binding.DataObject;
63 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
64 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
65 import org.opendaylight.yangtools.yang.common.RpcError;
66 import org.opendaylight.yangtools.yang.common.RpcResult;
67 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
68 import org.slf4j.Logger;
69 import org.slf4j.LoggerFactory;
74 public class DeviceContextImpl implements DeviceContext {
76 private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
78 private final ConnectionContext primaryConnectionContext;
79 private final DeviceState deviceState;
80 private final DataBroker dataBroker;
81 private final XidGenerator xidGenerator;
82 private final HashedWheelTimer hashedWheelTimer;
83 private Map<Long, RequestContext> requests = new TreeMap<>();
85 private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
86 private final TransactionChainManager txChainManager;
87 private TranslatorLibrary translatorLibrary;
88 private OpenflowMessageListenerFacade openflowMessageListenerFacade;
89 private final DeviceFlowRegistry deviceFlowRegistry;
90 private Timeout barrierTaskTimeout;
91 private NotificationProviderService notificationService;
94 DeviceContextImpl(@Nonnull final ConnectionContext primaryConnectionContext,
95 @Nonnull final DeviceState deviceState, @Nonnull final DataBroker dataBroker,
96 @Nonnull final HashedWheelTimer hashedWheelTimer) {
97 this.primaryConnectionContext = Preconditions.checkNotNull(primaryConnectionContext);
98 this.deviceState = Preconditions.checkNotNull(deviceState);
99 this.dataBroker = Preconditions.checkNotNull(dataBroker);
100 this.hashedWheelTimer = Preconditions.checkNotNull(hashedWheelTimer);
101 xidGenerator = new XidGenerator();
102 txChainManager = new TransactionChainManager(dataBroker, hashedWheelTimer, 500L);
103 auxiliaryConnectionContexts = new HashMap<>();
104 requests = new HashMap<>();
105 deviceFlowRegistry = new DeviceFlowRegistryImpl();
109 * This method is called from {@link DeviceManagerImpl} only. So we could say "posthandshake process finish"
110 * and we are able to set a scheduler for an automatic transaction submitting by time (0,5sec).
112 void submitTransaction() {
113 txChainManager.submitTransaction();
114 txChainManager.enableCounter();
118 public <M extends ChildOf<DataObject>> void onMessage(final M message, final RequestContext requestContext) {
119 // TODO Auto-generated method stub
124 public void addAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
125 final SwitchConnectionDistinguisher connectionDistinguisher = new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
126 auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
130 public void removeAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
131 // TODO Auto-generated method stub
135 public DeviceState getDeviceState() {
140 public ReadTransaction getReadTransaction() {
141 return dataBroker.newReadOnlyTransaction();
145 public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
146 final InstanceIdentifier<T> path, final T data) {
147 txChainManager.writeToTransaction(store, path, data);
151 public <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path) {
152 txChainManager.addDeleteOperationTotTxChain(store, path);
156 public TableFeatures getCapabilities() {
157 // TODO Auto-generated method stub
162 public ConnectionContext getPrimaryConnectionContext() {
163 return primaryConnectionContext;
167 public ConnectionContext getAuxiliaryConnectiobContexts(final BigInteger cookie) {
168 return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
172 public Xid getNextXid() {
173 return xidGenerator.generate();
177 public Map<Long, RequestContext> getRequests() {
182 public void hookRequestCtx(final Xid xid, final RequestContext requestFutureContext) {
183 // TODO Auto-generated method stub
184 requests.put(xid.getValue(), requestFutureContext);
188 public void attachOpenflowMessageListener(final OpenflowMessageListenerFacade openflowMessageListenerFacade) {
189 this.openflowMessageListenerFacade = openflowMessageListenerFacade;
190 primaryConnectionContext.getConnectionAdapter().setMessageListener(openflowMessageListenerFacade);
194 public OpenflowMessageListenerFacade getOpenflowMessageListenerFacade() {
195 return openflowMessageListenerFacade;
199 public DeviceFlowRegistry getDeviceFlowRegistry() {
200 return deviceFlowRegistry;
204 public void processReply(final OfHeader ofHeader) {
205 final RequestContext requestContext = getRequests().get(ofHeader.getXid());
206 if (null != requestContext) {
207 final SettableFuture replyFuture = requestContext.getFuture();
208 getRequests().remove(ofHeader.getXid());
209 RpcResult<OfHeader> rpcResult;
210 if (ofHeader instanceof Error) {
211 final Error error = (Error) ofHeader;
212 final String message = "Operation on device failed";
213 rpcResult = RpcResultBuilder
215 .withError(RpcError.ErrorType.APPLICATION, message, new DeviceDataException(message, error))
218 rpcResult = RpcResultBuilder
220 .withResult(ofHeader)
224 replyFuture.set(rpcResult);
226 requestContext.close();
227 } catch (final Exception e) {
228 LOG.error("Closing RequestContext failed: ", e);
231 LOG.error("Can't find request context registered for xid : {}", ofHeader.getXid());
236 public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
237 final RequestContext requestContext = getRequests().get(xid.getValue());
238 if (null != requestContext) {
239 final SettableFuture replyFuture = requestContext.getFuture();
240 getRequests().remove(xid.getValue());
241 final RpcResult<List<MultipartReply>> rpcResult = RpcResultBuilder
242 .<List<MultipartReply>>success()
243 .withResult(ofHeaderList)
245 replyFuture.set(rpcResult);
247 requestContext.close();
248 } catch (final Exception e) {
249 LOG.error("Closing RequestContext failed: ", e);
252 LOG.error("Can't find request context registered for xid : {}", xid.getValue());
257 public void processException(final Xid xid, final DeviceDataException deviceDataException) {
259 LOG.trace("Processing exception for xid : {}", xid.getValue());
261 final RequestContext requestContext = getRequests().get(xid.getValue());
263 if (null != requestContext) {
264 final SettableFuture replyFuture = requestContext.getFuture();
265 getRequests().remove(xid.getValue());
266 final RpcResult<List<OfHeader>> rpcResult = RpcResultBuilder
267 .<List<OfHeader>>failed()
268 .withError(RpcError.ErrorType.APPLICATION, String.format("Message processing failed : %s", deviceDataException.getError()), deviceDataException)
270 replyFuture.set(rpcResult);
272 requestContext.close();
273 } catch (final Exception e) {
274 LOG.error("Closing RequestContext failed: ", e);
277 LOG.error("Can't find request context registered for xid : {}", xid.getValue());
282 public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
283 //TODO: will be defined later
287 public void processPortStatusMessage(final PortStatusMessage portStatus) {
288 final TranslatorKey translatorKey = new TranslatorKey(portStatus.getVersion(), PortGrouping.class.getName());
289 final MessageTranslator<PortGrouping, FlowCapableNodeConnector> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
290 final FlowCapableNodeConnector flowCapableNodeConnector = messageTranslator.translate(portStatus, this, null);
292 final KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> iiToNodeConnector = provideIIToNodeConnector(portStatus.getPortNo(), portStatus.getVersion());
293 if (portStatus.getReason().equals(PortReason.OFPPRADD) || portStatus.getReason().equals(PortReason.OFPPRMODIFY)) {
294 // because of ADD status node connector has to be created
295 final NodeConnectorBuilder nConnectorBuilder = new NodeConnectorBuilder().setKey(iiToNodeConnector.getKey());
296 nConnectorBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
297 nConnectorBuilder.addAugmentation(FlowCapableNodeConnector.class, flowCapableNodeConnector);
298 writeToTransaction(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector, nConnectorBuilder.build());
299 } else if (portStatus.getReason().equals(PortReason.OFPPRDELETE) ) {
300 addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector);
304 private KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> provideIIToNodeConnector(final long portNo, final short version) {
305 final InstanceIdentifier<Node> iiToNodes = deviceState.getNodeInstanceIdentifier();
306 final BigInteger dataPathId = deviceState.getFeatures().getDatapathId();
307 final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), portNo, version);
308 return iiToNodes.child(NodeConnector.class, new NodeConnectorKey(nodeConnectorId));
312 public void processPacketInMessage(final PacketInMessage packetInMessage) {
313 final TranslatorKey translatorKey = new TranslatorKey(packetInMessage.getVersion(), PacketReceivedTranslator.class.getName());
314 final MessageTranslator<PacketInMessage, PacketReceived> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
315 final PacketReceived packetReceived = messageTranslator.translate(packetInMessage, this, null);
316 notificationService.publish(packetReceived);
320 public TranslatorLibrary oook() {
321 return translatorLibrary;
325 public void setTranslatorLibrary(final TranslatorLibrary translatorLibrary) {
326 this.translatorLibrary = translatorLibrary;
330 public HashedWheelTimer getTimer() {
331 return hashedWheelTimer;
335 private class XidGenerator {
337 private final AtomicLong xid = new AtomicLong(0);
339 public Xid generate() {
340 return new Xid(xid.incrementAndGet());
345 public RequestContext extractNextOutstandingMessage(final long barrierXid) {
346 RequestContext nextMessage = null;
347 final Iterator<Long> keyIterator = requests.keySet().iterator();
348 if (keyIterator.hasNext()) {
349 final Long oldestXid = keyIterator.next();
350 if (oldestXid < barrierXid) {
351 nextMessage = requests.remove(oldestXid);
358 public void setCurrentBarrierTimeout(final Timeout timeout) {
359 barrierTaskTimeout = timeout;
363 public Timeout getBarrierTaskTimeout() {
364 return barrierTaskTimeout;
368 public void setNotificationService(final NotificationProviderService notificationServiceParam) {
369 notificationService = notificationServiceParam;