openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/DeviceContextImpl.java

   1 /**
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.openflowplugin.impl.device;
   9
  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;
  19 import java.util.Map;
  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.openflow.md.core.session.SwitchConnectionCookieOFImpl;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortReason;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketIn;
  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;
  70
  71 /**
  72  *
  73  */
  74 public class DeviceContextImpl implements DeviceContext {
  75
  76     private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
  77
  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<>();
  84
  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;
  92
  93     @VisibleForTesting
  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();
 106     }
 107
 108     /**
 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).
 111      */
 112     void submitTransaction() {
 113         txChainManager.submitTransaction();
 114         txChainManager.enableCounter();
 115     }
 116
 117     @Override
 118     public <M extends ChildOf<DataObject>> void onMessage(final M message, final RequestContext requestContext) {
 119         // TODO Auto-generated method stub
 120
 121     }
 122
 123     @Override
 124     public void addAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 125         final SwitchConnectionDistinguisher connectionDistinguisher = new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
 126         auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
 127     }
 128
 129     @Override
 130     public void removeAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 131         // TODO Auto-generated method stub
 132     }
 133
 134     @Override
 135     public DeviceState getDeviceState() {
 136         return deviceState;
 137     }
 138
 139     @Override
 140     public ReadTransaction getReadTransaction() {
 141         return dataBroker.newReadOnlyTransaction();
 142     }
 143
 144     @Override
 145     public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
 146                                                           final InstanceIdentifier<T> path, final T data) {
 147         txChainManager.writeToTransaction(store, path, data);
 148     }
 149
 150     @Override
 151     public <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path) {
 152         txChainManager.addDeleteOperationTotTxChain(store, path);
 153     }
 154
 155     @Override
 156     public TableFeatures getCapabilities() {
 157         // TODO Auto-generated method stub
 158         return null;
 159     }
 160
 161     @Override
 162     public ConnectionContext getPrimaryConnectionContext() {
 163         return primaryConnectionContext;
 164     }
 165
 166     @Override
 167     public ConnectionContext getAuxiliaryConnectiobContexts(final BigInteger cookie) {
 168         return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
 169     }
 170
 171     @Override
 172     public Xid getNextXid() {
 173         return xidGenerator.generate();
 174     }
 175
 176     @Override
 177     public Map<Long, RequestContext> getRequests() {
 178         return requests;
 179     }
 180
 181     @Override
 182     public void hookRequestCtx(final Xid xid, final RequestContext requestFutureContext) {
 183         // TODO Auto-generated method stub
 184         requests.put(xid.getValue(), requestFutureContext);
 185     }
 186
 187     @Override
 188     public void attachOpenflowMessageListener(final OpenflowMessageListenerFacade openflowMessageListenerFacade) {
 189         this.openflowMessageListenerFacade = openflowMessageListenerFacade;
 190         primaryConnectionContext.getConnectionAdapter().setMessageListener(openflowMessageListenerFacade);
 191     }
 192
 193     @Override
 194     public OpenflowMessageListenerFacade getOpenflowMessageListenerFacade() {
 195         return openflowMessageListenerFacade;
 196     }
 197
 198     @Override
 199     public DeviceFlowRegistry getDeviceFlowRegistry() {
 200         return deviceFlowRegistry;
 201     }
 202
 203     @Override
 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
 214                         .<OfHeader>failed()
 215                         .withError(RpcError.ErrorType.APPLICATION, message, new DeviceDataException(message, error))
 216                         .build();
 217             } else {
 218                 rpcResult = RpcResultBuilder
 219                         .<OfHeader>success()
 220                         .withResult(ofHeader)
 221                         .build();
 222             }
 223
 224             replyFuture.set(rpcResult);
 225             try {
 226                 requestContext.close();
 227             } catch (final Exception e) {
 228                 LOG.error("Closing RequestContext failed: ", e);
 229             }
 230         } else {
 231             LOG.error("Can't find request context registered for xid : {}. Type of reply: {}. From address: {}", ofHeader.getXid(), ofHeader.getClass().getName(),
 232                     getPrimaryConnectionContext().getConnectionAdapter().getRemoteAddress());
 233         }
 234     }
 235
 236     @Override
 237     public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
 238         final RequestContext requestContext = getRequests().get(xid.getValue());
 239         if (null != requestContext) {
 240             final SettableFuture replyFuture = requestContext.getFuture();
 241             getRequests().remove(xid.getValue());
 242             final RpcResult<List<MultipartReply>> rpcResult = RpcResultBuilder
 243                     .<List<MultipartReply>>success()
 244                     .withResult(ofHeaderList)
 245                     .build();
 246             replyFuture.set(rpcResult);
 247             try {
 248                 requestContext.close();
 249             } catch (final Exception e) {
 250                 LOG.error("Closing RequestContext failed: ", e);
 251             }
 252         } else {
 253             LOG.error("Can't find request context registered for xid : {}. Type of reply: MULTIPART. From address: {}", xid.getValue(),
 254                     getPrimaryConnectionContext().getConnectionAdapter().getRemoteAddress());
 255         }
 256     }
 257
 258     @Override
 259     public void processException(final Xid xid, final DeviceDataException deviceDataException) {
 260
 261         LOG.trace("Processing exception for xid : {}", xid.getValue());
 262
 263         final RequestContext requestContext = getRequests().get(xid.getValue());
 264
 265         if (null != requestContext) {
 266             final SettableFuture replyFuture = requestContext.getFuture();
 267             getRequests().remove(xid.getValue());
 268             final RpcResult<List<OfHeader>> rpcResult = RpcResultBuilder
 269                     .<List<OfHeader>>failed()
 270                     .withError(RpcError.ErrorType.APPLICATION, String.format("Message processing failed : %s", deviceDataException.getError()), deviceDataException)
 271                     .build();
 272             replyFuture.set(rpcResult);
 273             try {
 274                 requestContext.close();
 275             } catch (final Exception e) {
 276                 LOG.error("Closing RequestContext failed: ", e);
 277             }
 278         } else {
 279             LOG.error("Can't find request context registered for xid : {}", xid.getValue());
 280         }
 281     }
 282
 283     @Override
 284     public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
 285         //TODO: will be defined later
 286     }
 287
 288     @Override
 289     public void processPortStatusMessage(final PortStatusMessage portStatus) {
 290         final TranslatorKey translatorKey = new TranslatorKey(portStatus.getVersion(), PortGrouping.class.getName());
 291         final MessageTranslator<PortGrouping, FlowCapableNodeConnector> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
 292         final FlowCapableNodeConnector flowCapableNodeConnector = messageTranslator.translate(portStatus, this, null);
 293
 294         final KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> iiToNodeConnector = provideIIToNodeConnector(portStatus.getPortNo(), portStatus.getVersion());
 295         if (portStatus.getReason().equals(PortReason.OFPPRADD) || portStatus.getReason().equals(PortReason.OFPPRMODIFY)) {
 296             // because of ADD status node connector has to be created
 297             final NodeConnectorBuilder nConnectorBuilder = new NodeConnectorBuilder().setKey(iiToNodeConnector.getKey());
 298             nConnectorBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
 299             nConnectorBuilder.addAugmentation(FlowCapableNodeConnector.class, flowCapableNodeConnector);
 300             writeToTransaction(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector, nConnectorBuilder.build());
 301         } else if (portStatus.getReason().equals(PortReason.OFPPRDELETE) ) {
 302             addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector);
 303         }
 304     }
 305
 306     private KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> provideIIToNodeConnector(final long portNo, final short version) {
 307         final InstanceIdentifier<Node> iiToNodes = deviceState.getNodeInstanceIdentifier();
 308         final BigInteger dataPathId = deviceState.getFeatures().getDatapathId();
 309         final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), portNo, version);
 310         return iiToNodes.child(NodeConnector.class, new NodeConnectorKey(nodeConnectorId));
 311     }
 312
 313     @Override
 314     public void processPacketInMessage(final PacketInMessage packetInMessage) {
 315         final TranslatorKey translatorKey = new TranslatorKey(packetInMessage.getVersion(), PacketIn.class.getName());
 316         final MessageTranslator<PacketInMessage, PacketReceived> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
 317         final PacketReceived packetReceived = messageTranslator.translate(packetInMessage, this, null);
 318         notificationService.publish(packetReceived);
 319     }
 320
 321     @Override
 322     public TranslatorLibrary oook() {
 323         return translatorLibrary;
 324     }
 325
 326     @Override
 327     public void setTranslatorLibrary(final TranslatorLibrary translatorLibrary) {
 328         this.translatorLibrary = translatorLibrary;
 329     }
 330
 331     @Override
 332     public HashedWheelTimer getTimer() {
 333         return hashedWheelTimer;
 334     }
 335
 336
 337     private class XidGenerator {
 338
 339         private final AtomicLong xid = new AtomicLong(0);
 340
 341         public Xid generate() {
 342             return new Xid(xid.incrementAndGet());
 343         }
 344     }
 345
 346     @Override
 347     public RequestContext extractNextOutstandingMessage(final long barrierXid) {
 348         RequestContext nextMessage = null;
 349         final Iterator<Long> keyIterator = requests.keySet().iterator();
 350         if (keyIterator.hasNext()) {
 351             final Long oldestXid = keyIterator.next();
 352             if (oldestXid < barrierXid) {
 353                 nextMessage = requests.remove(oldestXid);
 354             }
 355         }
 356         return nextMessage;
 357     }
 358
 359     @Override
 360     public void setCurrentBarrierTimeout(final Timeout timeout) {
 361         barrierTaskTimeout = timeout;
 362     }
 363
 364     @Override
 365     public Timeout getBarrierTaskTimeout() {
 366         return barrierTaskTimeout;
 367     }
 368
 369     @Override
 370     public void setNotificationService(final NotificationProviderService notificationServiceParam) {
 371         notificationService = notificationServiceParam;
 372     }
 373 }