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 io.netty.util.TimerTask;
  16 import java.math.BigInteger;
  17 import java.util.HashMap;
  18 import java.util.Iterator;
  19 import java.util.List;
  20 import java.util.Map;
  21 import java.util.TreeMap;
  22 import java.util.concurrent.TimeUnit;
  23 import java.util.concurrent.atomic.AtomicLong;
  24 import javax.annotation.Nonnull;
  25 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  26 import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
  27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  28 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  29 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  30 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  31 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
  32 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  33 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
  34 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  35 import org.opendaylight.openflowplugin.api.openflow.device.exception.DeviceDataException;
  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.impl.translator.PacketReceivedTranslator;
  39 import org.opendaylight.openflowplugin.openflow.md.core.session.SwitchConnectionCookieOFImpl;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableFeatures;
  49 import org.opendaylight.yangtools.yang.binding.ChildOf;
  50 import org.opendaylight.yangtools.yang.binding.DataObject;
  51 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  52 import org.opendaylight.yangtools.yang.common.RpcError;
  53 import org.opendaylight.yangtools.yang.common.RpcResult;
  54 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  55 import org.slf4j.Logger;
  56 import org.slf4j.LoggerFactory;
  57
  58 /**
  59  *
  60  */
  61 public class DeviceContextImpl implements DeviceContext {
  62
  63     private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
  64
  65     private final ConnectionContext primaryConnectionContext;
  66     private final DeviceState deviceState;
  67     private final DataBroker dataBroker;
  68     private final XidGenerator xidGenerator;
  69     private final HashedWheelTimer hashedWheelTimer;
  70     private Map<Long, RequestContext> requests = new TreeMap<>();
  71
  72     private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
  73     private final TransactionChainManager txChainManager;
  74     private TranslatorLibrary translatorLibrary;
  75
  76     @VisibleForTesting
  77     DeviceContextImpl(@Nonnull final ConnectionContext primaryConnectionContext,
  78                       @Nonnull final DeviceState deviceState, @Nonnull final DataBroker dataBroker,
  79                       @Nonnull final HashedWheelTimer hashedWheelTimer) {
  80         this.primaryConnectionContext = Preconditions.checkNotNull(primaryConnectionContext);
  81         this.deviceState = Preconditions.checkNotNull(deviceState);
  82         this.dataBroker = Preconditions.checkNotNull(dataBroker);
  83         this.hashedWheelTimer = Preconditions.checkNotNull(hashedWheelTimer);
  84         xidGenerator = new XidGenerator();
  85         txChainManager = new TransactionChainManager(dataBroker, 500L);
  86         auxiliaryConnectionContexts = new HashMap<>();
  87         requests = new HashMap<>();
  88     }
  89
  90     /**
  91      * This method is called from {@link DeviceManagerImpl} only. So we could say "posthandshake process finish"
  92      * and we are able to set a scheduler for an automatic transaction submitting by time (0,5sec).
  93      */
  94     void submitTransaction() {
  95         txChainManager.submitTransaction();
  96         txChainManager.enableCounter();
  97         hashedWheelTimer.newTimeout(new TimerTask() {
  98             @Override
  99             public void run(final Timeout timeout) throws Exception {
 100                 submitTransaction();
 101             }
 102         }, 0, TimeUnit.MILLISECONDS);
 103     }
 104
 105     @Override
 106     public <M extends ChildOf<DataObject>> void onMessage(final M message, final RequestContext requestContext) {
 107         // TODO Auto-generated method stub
 108
 109     }
 110
 111     @Override
 112     public void addAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 113         final SwitchConnectionDistinguisher connectionDistinguisher = new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
 114         auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
 115     }
 116
 117     @Override
 118     public void removeAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 119         // TODO Auto-generated method stub
 120     }
 121
 122     @Override
 123     public DeviceState getDeviceState() {
 124         return deviceState;
 125     }
 126
 127     @Override
 128     public ReadTransaction getReadTransaction() {
 129         return dataBroker.newReadOnlyTransaction();
 130     }
 131
 132     @Override
 133     public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
 134                                                           final InstanceIdentifier<T> path, final T data) {
 135         txChainManager.writeToTransaction(store, path, data);
 136     }
 137
 138     @Override
 139     public TableFeatures getCapabilities() {
 140         // TODO Auto-generated method stub
 141         return null;
 142     }
 143
 144     @Override
 145     public ConnectionContext getPrimaryConnectionContext() {
 146         return primaryConnectionContext;
 147     }
 148
 149     @Override
 150     public ConnectionContext getAuxiliaryConnectiobContexts(final BigInteger cookie) {
 151         return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
 152     }
 153
 154     @Override
 155     public Xid getNextXid() {
 156         return xidGenerator.generate();
 157     }
 158
 159     public Map<Long, RequestContext> getRequests() {
 160         return requests;
 161     }
 162
 163     @Override
 164     public void hookRequestCtx(final Xid xid, final RequestContext requestFutureContext) {
 165         // TODO Auto-generated method stub
 166         requests.put(xid.getValue(), requestFutureContext);
 167     }
 168
 169     @Override
 170     public void processReply(final OfHeader ofHeader) {
 171         final RequestContext requestContext = getRequests().get(ofHeader.getXid());
 172         final SettableFuture replyFuture = requestContext.getFuture();
 173         getRequests().remove(ofHeader.getXid());
 174         RpcResult<OfHeader> rpcResult;
 175
 176         if (ofHeader instanceof Error) {
 177             final Error error = (Error) ofHeader;
 178             final String message = "Operation on device failed";
 179             rpcResult = RpcResultBuilder
 180                     .<OfHeader>failed()
 181                     .withError(RpcError.ErrorType.APPLICATION, message, new DeviceDataException(message, error))
 182                     .build();
 183         } else {
 184             rpcResult = RpcResultBuilder
 185                     .<OfHeader>success()
 186                     .withResult(ofHeader)
 187                     .build();
 188         }
 189
 190         replyFuture.set(rpcResult);
 191         try {
 192             requestContext.close();
 193         } catch (final Exception e) {
 194             LOG.error("Closing RequestContext failed: ", e);
 195         }
 196     }
 197
 198     @Override
 199     public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
 200         final RequestContext requestContext = getRequests().get(xid.getValue());
 201         final SettableFuture replyFuture = requestContext.getFuture();
 202         getRequests().remove(xid.getValue());
 203         final RpcResult<List<MultipartReply>> rpcResult = RpcResultBuilder
 204                 .<List<MultipartReply>>success()
 205                 .withResult(ofHeaderList)
 206                 .build();
 207         replyFuture.set(rpcResult);
 208         try {
 209             requestContext.close();
 210         } catch (final Exception e) {
 211             LOG.error("Closing RequestContext failed: ", e);
 212         }
 213     }
 214
 215     @Override
 216     public void processException(final Xid xid, final DeviceDataException deviceDataException) {
 217
 218         LOG.trace("Processing exception for xid : {}", xid.getValue());
 219
 220         final RequestContext requestContext = getRequests().get(xid.getValue());
 221
 222         if (null != requestContext) {
 223             final SettableFuture replyFuture = requestContext.getFuture();
 224             getRequests().remove(xid.getValue());
 225             final RpcResult<List<OfHeader>> rpcResult = RpcResultBuilder
 226                     .<List<OfHeader>>failed()
 227                     .withError(RpcError.ErrorType.APPLICATION, String.format("Message processing failed : %s", deviceDataException.getError()), deviceDataException)
 228                     .build();
 229             replyFuture.set(rpcResult);
 230             try {
 231                 requestContext.close();
 232             } catch (final Exception e) {
 233                 LOG.error("Closing RequestContext failed: ", e);
 234             }
 235         } else {
 236             LOG.error("Can't find request context registered for xid : {}", xid);
 237         }
 238     }
 239
 240     @Override
 241     public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
 242         //TODO: will be defined later
 243     }
 244
 245     @Override
 246     public void processPortStatusMessage(final PortStatusMessage portStatus) {
 247         final TranslatorKey translatorKey = new TranslatorKey(portStatus.getVersion(), PortStatusMessage.class.getName());
 248         final MessageTranslator<PortStatusMessage, FlowCapableNodeConnector> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
 249         final FlowCapableNodeConnector nodeConnector = messageTranslator.translate(portStatus, this, null);
 250         //TODO write into datastore
 251     }
 252
 253     @Override
 254     public void processPacketInMessage(final PacketInMessage packetInMessage) {
 255         final TranslatorKey translatorKey = new TranslatorKey(packetInMessage.getVersion(), PacketReceivedTranslator.class.getName());
 256         final MessageTranslator<PacketInMessage, PacketReceived> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
 257         final PacketReceived packetReceived = messageTranslator.translate(packetInMessage, this, null);
 258         //TODO publish to MD-SAL
 259     }
 260
 261     @Override
 262     public TranslatorLibrary oook() {
 263         return translatorLibrary;
 264     }
 265
 266     @Override
 267     public void setTranslatorLibrary(final TranslatorLibrary translatorLibrary) {
 268         this.translatorLibrary = translatorLibrary;
 269     }
 270
 271
 272     private class XidGenerator {
 273
 274         private final AtomicLong xid = new AtomicLong(0);
 275
 276         public Xid generate() {
 277             return new Xid(xid.incrementAndGet());
 278         }
 279     }
 280
 281     @Override
 282     public RequestContext extractNextOutstandingMessage(long barrierXid) {
 283         RequestContext nextMessage = null;
 284         Iterator<Long> keyIterator = requests.keySet().iterator();
 285         if (keyIterator.hasNext()) {
 286             Long oldestXid = keyIterator.next();
 287             if (oldestXid < barrierXid) {
 288                 nextMessage = requests.remove(oldestXid);
 289             }
 290         }
 291         return nextMessage;
 292     }
 293 }