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