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.md.core.SwitchConnectionDistinguisher;
  37 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
  38 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
  39 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
  40 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
  41 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
  42 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
  43 import org.opendaylight.openflowplugin.impl.registry.group.DeviceGroupRegistryImpl;
  44 import org.opendaylight.openflowplugin.impl.registry.meter.DeviceMeterRegistryImpl;
  45 import org.opendaylight.openflowplugin.openflow.md.core.session.SwitchConnectionCookieOFImpl;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortReason;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketIn;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableFeatures;
  65 import org.opendaylight.yangtools.yang.binding.ChildOf;
  66 import org.opendaylight.yangtools.yang.binding.DataObject;
  67 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  68 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  69 import org.opendaylight.yangtools.yang.common.RpcError;
  70 import org.opendaylight.yangtools.yang.common.RpcResult;
  71 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  72 import org.slf4j.Logger;
  73 import org.slf4j.LoggerFactory;
  74
  75 /**
  76  *
  77  */
  78 public class DeviceContextImpl implements DeviceContext {
  79
  80     private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
  81
  82     private final ConnectionContext primaryConnectionContext;
  83     private final DeviceState deviceState;
  84     private final DataBroker dataBroker;
  85     private final XidGenerator xidGenerator;
  86     private final HashedWheelTimer hashedWheelTimer;
  87     private Map<Long, RequestContext> requests = new TreeMap<>();
  88
  89     private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
  90     private final TransactionChainManager txChainManager;
  91     private TranslatorLibrary translatorLibrary;
  92     private OpenflowMessageListenerFacade openflowMessageListenerFacade;
  93     private final DeviceFlowRegistry deviceFlowRegistry;
  94     private final DeviceGroupRegistry deviceGroupRegistry;
  95     private final DeviceMeterRegistry deviceMeterRegistry;
  96     private Timeout barrierTaskTimeout;
  97     private NotificationProviderService notificationService;
  98
  99     @VisibleForTesting
 100     DeviceContextImpl(@Nonnull final ConnectionContext primaryConnectionContext,
 101                       @Nonnull final DeviceState deviceState, @Nonnull final DataBroker dataBroker,
 102                       @Nonnull final HashedWheelTimer hashedWheelTimer) {
 103         this.primaryConnectionContext = Preconditions.checkNotNull(primaryConnectionContext);
 104         this.deviceState = Preconditions.checkNotNull(deviceState);
 105         this.dataBroker = Preconditions.checkNotNull(dataBroker);
 106         this.hashedWheelTimer = Preconditions.checkNotNull(hashedWheelTimer);
 107         xidGenerator = new XidGenerator();
 108         txChainManager = new TransactionChainManager(dataBroker, hashedWheelTimer, 500L);
 109         auxiliaryConnectionContexts = new HashMap<>();
 110         requests = new HashMap<>();
 111         deviceFlowRegistry = new DeviceFlowRegistryImpl();
 112         deviceGroupRegistry = new DeviceGroupRegistryImpl();
 113         deviceMeterRegistry = new DeviceMeterRegistryImpl();
 114     }
 115
 116     /**
 117      * This method is called from {@link DeviceManagerImpl} only. So we could say "posthandshake process finish"
 118      * and we are able to set a scheduler for an automatic transaction submitting by time (0,5sec).
 119      */
 120     void submitTransaction() {
 121         txChainManager.submitTransaction();
 122         txChainManager.enableCounter();
 123     }
 124
 125     @Override
 126     public <M extends ChildOf<DataObject>> void onMessage(final M message, final RequestContext requestContext) {
 127         // TODO Auto-generated method stub
 128
 129     }
 130
 131     @Override
 132     public void addAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 133         final SwitchConnectionDistinguisher connectionDistinguisher = new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
 134         auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
 135     }
 136
 137     @Override
 138     public void removeAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 139         // TODO Auto-generated method stub
 140     }
 141
 142     @Override
 143     public DeviceState getDeviceState() {
 144         return deviceState;
 145     }
 146
 147     @Override
 148     public ReadTransaction getReadTransaction() {
 149         return dataBroker.newReadOnlyTransaction();
 150     }
 151
 152     @Override
 153     public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
 154                                                           final InstanceIdentifier<T> path, final T data) {
 155         txChainManager.writeToTransaction(store, path, data);
 156     }
 157
 158     @Override
 159     public <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path) {
 160         txChainManager.addDeleteOperationTotTxChain(store, path);
 161     }
 162
 163     @Override
 164     public TableFeatures getCapabilities() {
 165         // TODO Auto-generated method stub
 166         return null;
 167     }
 168
 169     @Override
 170     public ConnectionContext getPrimaryConnectionContext() {
 171         return primaryConnectionContext;
 172     }
 173
 174     @Override
 175     public ConnectionContext getAuxiliaryConnectiobContexts(final BigInteger cookie) {
 176         return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
 177     }
 178
 179     @Override
 180     public Xid getNextXid() {
 181         return xidGenerator.generate();
 182     }
 183
 184     @Override
 185     public Map<Long, RequestContext> getRequests() {
 186         return requests;
 187     }
 188
 189     @Override
 190     public void hookRequestCtx(final Xid xid, final RequestContext requestFutureContext) {
 191         // TODO Auto-generated method stub
 192         requests.put(xid.getValue(), requestFutureContext);
 193     }
 194
 195     @Override
 196     public void attachOpenflowMessageListener(final OpenflowMessageListenerFacade openflowMessageListenerFacade) {
 197         this.openflowMessageListenerFacade = openflowMessageListenerFacade;
 198         primaryConnectionContext.getConnectionAdapter().setMessageListener(openflowMessageListenerFacade);
 199     }
 200
 201     @Override
 202     public OpenflowMessageListenerFacade getOpenflowMessageListenerFacade() {
 203         return openflowMessageListenerFacade;
 204     }
 205
 206     @Override
 207     public DeviceFlowRegistry getDeviceFlowRegistry() {
 208         return deviceFlowRegistry;
 209     }
 210
 211     @Override
 212     public DeviceGroupRegistry getDeviceGroupRegistry() {
 213         return deviceGroupRegistry;
 214     }
 215
 216     @Override
 217     public DeviceMeterRegistry getDeviceMeterRegistry() {
 218         return deviceMeterRegistry;
 219     }
 220
 221     @Override
 222     public void processReply(final OfHeader ofHeader) {
 223         final RequestContext requestContext = getRequests().get(ofHeader.getXid());
 224         if (null != requestContext) {
 225             final SettableFuture replyFuture = requestContext.getFuture();
 226             getRequests().remove(ofHeader.getXid());
 227             RpcResult<OfHeader> rpcResult;
 228             if (ofHeader instanceof Error) {
 229                 final Error error = (Error) ofHeader;
 230                 final String message = "Operation on device failed";
 231                 rpcResult = RpcResultBuilder
 232                         .<OfHeader>failed()
 233                         .withError(RpcError.ErrorType.APPLICATION, message, new DeviceDataException(message, error))
 234                         .build();
 235             } else {
 236                 rpcResult = RpcResultBuilder
 237                         .<OfHeader>success()
 238                         .withResult(ofHeader)
 239                         .build();
 240             }
 241
 242             replyFuture.set(rpcResult);
 243             try {
 244                 requestContext.close();
 245             } catch (final Exception e) {
 246                 LOG.error("Closing RequestContext failed: ", e);
 247             }
 248         } else {
 249             LOG.error("Can't find request context registered for xid : {}. Type of reply: {}. From address: {}", ofHeader.getXid(), ofHeader.getClass().getName(),
 250                     getPrimaryConnectionContext().getConnectionAdapter().getRemoteAddress());
 251         }
 252     }
 253
 254     @Override
 255     public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
 256         final RequestContext requestContext = getRequests().get(xid.getValue());
 257         if (null != requestContext) {
 258             final SettableFuture replyFuture = requestContext.getFuture();
 259             getRequests().remove(xid.getValue());
 260             final RpcResult<List<MultipartReply>> rpcResult = RpcResultBuilder
 261                     .<List<MultipartReply>>success()
 262                     .withResult(ofHeaderList)
 263                     .build();
 264             replyFuture.set(rpcResult);
 265             try {
 266                 requestContext.close();
 267             } catch (final Exception e) {
 268                 LOG.error("Closing RequestContext failed: ", e);
 269             }
 270         } else {
 271             LOG.error("Can't find request context registered for xid : {}. Type of reply: MULTIPART. From address: {}", xid.getValue(),
 272                     getPrimaryConnectionContext().getConnectionAdapter().getRemoteAddress());
 273         }
 274     }
 275
 276     @Override
 277     public void processException(final Xid xid, final DeviceDataException deviceDataException) {
 278
 279         LOG.trace("Processing exception for xid : {}", xid.getValue());
 280
 281         final RequestContext requestContext = getRequests().get(xid.getValue());
 282
 283         if (null != requestContext) {
 284             final SettableFuture replyFuture = requestContext.getFuture();
 285             getRequests().remove(xid.getValue());
 286             final RpcResult<List<OfHeader>> rpcResult = RpcResultBuilder
 287                     .<List<OfHeader>>failed()
 288                     .withError(RpcError.ErrorType.APPLICATION, String.format("Message processing failed : %s", deviceDataException.getError()), deviceDataException)
 289                     .build();
 290             replyFuture.set(rpcResult);
 291             try {
 292                 requestContext.close();
 293             } catch (final Exception e) {
 294                 LOG.error("Closing RequestContext failed: ", e);
 295             }
 296         } else {
 297             LOG.error("Can't find request context registered for xid : {}", xid.getValue());
 298         }
 299     }
 300
 301     @Override
 302     public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
 303         //TODO: will be defined later
 304     }
 305
 306     @Override
 307     public void processPortStatusMessage(final PortStatusMessage portStatus) {
 308         final TranslatorKey translatorKey = new TranslatorKey(portStatus.getVersion(), PortGrouping.class.getName());
 309         final MessageTranslator<PortGrouping, FlowCapableNodeConnector> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
 310         final FlowCapableNodeConnector flowCapableNodeConnector = messageTranslator.translate(portStatus, this, null);
 311
 312         final KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> iiToNodeConnector = provideIIToNodeConnector(portStatus.getPortNo(), portStatus.getVersion());
 313         if (portStatus.getReason().equals(PortReason.OFPPRADD) || portStatus.getReason().equals(PortReason.OFPPRMODIFY)) {
 314             // because of ADD status node connector has to be created
 315             final NodeConnectorBuilder nConnectorBuilder = new NodeConnectorBuilder().setKey(iiToNodeConnector.getKey());
 316             nConnectorBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
 317             nConnectorBuilder.addAugmentation(FlowCapableNodeConnector.class, flowCapableNodeConnector);
 318             writeToTransaction(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector, nConnectorBuilder.build());
 319         } else if (portStatus.getReason().equals(PortReason.OFPPRDELETE)) {
 320             addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector);
 321         }
 322     }
 323
 324     private KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> provideIIToNodeConnector(final long portNo, final short version) {
 325         final InstanceIdentifier<Node> iiToNodes = deviceState.getNodeInstanceIdentifier();
 326         final BigInteger dataPathId = deviceState.getFeatures().getDatapathId();
 327         final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), portNo, version);
 328         return iiToNodes.child(NodeConnector.class, new NodeConnectorKey(nodeConnectorId));
 329     }
 330
 331     @Override
 332     public void processPacketInMessage(final PacketInMessage packetInMessage) {
 333         final TranslatorKey translatorKey = new TranslatorKey(packetInMessage.getVersion(), PacketIn.class.getName());
 334         final MessageTranslator<PacketInMessage, PacketReceived> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
 335         final PacketReceived packetReceived = messageTranslator.translate(packetInMessage, this, null);
 336         notificationService.publish(packetReceived);
 337     }
 338
 339     @Override
 340     public TranslatorLibrary oook() {
 341         return translatorLibrary;
 342     }
 343
 344     @Override
 345     public void setTranslatorLibrary(final TranslatorLibrary translatorLibrary) {
 346         this.translatorLibrary = translatorLibrary;
 347     }
 348
 349     @Override
 350     public HashedWheelTimer getTimer() {
 351         return hashedWheelTimer;
 352     }
 353
 354     @Override
 355     public void close() throws Exception {
 356         for (Map.Entry<Long, RequestContext> entry : requests.entrySet()){
 357             entry.getValue().close();
 358         }
 359     }
 360
 361
 362     private class XidGenerator {
 363
 364         private final AtomicLong xid = new AtomicLong(0);
 365
 366         public Xid generate() {
 367             return new Xid(xid.incrementAndGet());
 368         }
 369     }
 370
 371     @Override
 372     public RequestContext extractNextOutstandingMessage(final long barrierXid) {
 373         RequestContext nextMessage = null;
 374         final Iterator<Long> keyIterator = requests.keySet().iterator();
 375         if (keyIterator.hasNext()) {
 376             final Long oldestXid = keyIterator.next();
 377             if (oldestXid < barrierXid) {
 378                 nextMessage = requests.remove(oldestXid);
 379             }
 380         }
 381         return nextMessage;
 382     }
 383
 384     @Override
 385     public void setCurrentBarrierTimeout(final Timeout timeout) {
 386         barrierTaskTimeout = timeout;
 387     }
 388
 389     @Override
 390     public Timeout getBarrierTaskTimeout() {
 391         return barrierTaskTimeout;
 392     }
 393
 394     @Override
 395     public void setNotificationService(final NotificationProviderService notificationServiceParam) {
 396         notificationService = notificationServiceParam;
 397     }
 398 }