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 org.opendaylight.controller.md.sal.binding.api.DataBroker;
  17 import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
  18 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  19 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  20 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  21 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  22 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
  23 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  24 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
  25 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  26 import org.opendaylight.openflowplugin.api.openflow.device.exception.DeviceDataException;
  27 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
  28 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
  29 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
  30 import org.opendaylight.openflowplugin.impl.translator.PacketReceivedTranslator;
  31 import org.opendaylight.openflowplugin.impl.translator.PortUpdateTranslator;
  32 import org.opendaylight.openflowplugin.openflow.md.core.session.SwitchConnectionCookieOFImpl;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableFeatures;
  42 import org.opendaylight.yangtools.yang.binding.ChildOf;
  43 import org.opendaylight.yangtools.yang.binding.DataObject;
  44 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  45 import org.opendaylight.yangtools.yang.common.RpcError;
  46 import org.opendaylight.yangtools.yang.common.RpcResult;
  47 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50 import javax.annotation.Nonnull;
  51 import java.math.BigInteger;
  52 import java.util.HashMap;
  53 import java.util.List;
  54 import java.util.Map;
  55 import java.util.concurrent.TimeUnit;
  56 import java.util.concurrent.atomic.AtomicLong;
  57
  58 /**
  59  *
  60  */
  61 public class DeviceContextImpl implements DeviceContext, DeviceReplyProcessor {
  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 HashMap<Long, RequestContext>();
  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         hashedWheelTimer.newTimeout(new TimerTask() {
  97             @Override
  98             public void run(final Timeout timeout) throws Exception {
  99                 submitTransaction();
 100             }
 101         }, 0, TimeUnit.MILLISECONDS);
 102     }
 103
 104     @Override
 105     public <M extends ChildOf<DataObject>> void onMessage(final M message, final RequestContext requestContext) {
 106         // TODO Auto-generated method stub
 107
 108     }
 109
 110     @Override
 111     public void addAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 112         final SwitchConnectionDistinguisher connectionDistinguisher = new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
 113         auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
 114     }
 115
 116     @Override
 117     public void removeAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 118         // TODO Auto-generated method stub
 119     }
 120
 121     @Override
 122     public DeviceState getDeviceState() {
 123         return deviceState;
 124     }
 125
 126     @Override
 127     public ReadTransaction getReadTransaction() {
 128         return dataBroker.newReadOnlyTransaction();
 129     }
 130
 131     @Override
 132     public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
 133                                                           final InstanceIdentifier<T> path, final T data) {
 134         txChainManager.writeToTransaction(store, path, data);
 135     }
 136
 137     @Override
 138     public TableFeatures getCapabilities() {
 139         // TODO Auto-generated method stub
 140         return null;
 141     }
 142
 143     @Override
 144     public ConnectionContext getPrimaryConnectionContext() {
 145         return primaryConnectionContext;
 146     }
 147
 148     @Override
 149     public ConnectionContext getAuxiliaryConnectiobContexts(final BigInteger cookie) {
 150         return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
 151     }
 152
 153     @Override
 154     public Xid getNextXid() {
 155         return xidGenerator.generate();
 156     }
 157
 158     public Map<Long, RequestContext> getRequests() {
 159         return requests;
 160     }
 161
 162     @Override
 163     public void hookRequestCtx(final Xid xid, final RequestContext requestFutureContext) {
 164         // TODO Auto-generated method stub
 165         requests.put(xid.getValue(), requestFutureContext);
 166     }
 167
 168     @Override
 169     public void processReply(final OfHeader ofHeader) {
 170         final RequestContext requestContext = getRequests().get(ofHeader.getXid());
 171         final SettableFuture replyFuture = requestContext.getFuture();
 172         getRequests().remove(ofHeader.getXid());
 173         RpcResult<OfHeader> rpcResult;
 174
 175         if (ofHeader instanceof Error) {
 176             final Error error = (Error) ofHeader;
 177             final String message = "Operation on device failed";
 178             rpcResult = RpcResultBuilder
 179                     .<OfHeader>failed()
 180                     .withError(RpcError.ErrorType.APPLICATION, message, new DeviceDataException(message, error))
 181                     .build();
 182         } else {
 183             rpcResult = RpcResultBuilder
 184                     .<OfHeader>success()
 185                     .withResult(ofHeader)
 186                     .build();
 187         }
 188
 189         replyFuture.set(rpcResult);
 190         try {
 191             requestContext.close();
 192         } catch (final Exception e) {
 193             LOG.error("Closing RequestContext failed: ", e);
 194         }
 195     }
 196
 197     @Override
 198     public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
 199         final RequestContext requestContext = getRequests().get(xid.getValue());
 200         final SettableFuture replyFuture = requestContext.getFuture();
 201         getRequests().remove(xid.getValue());
 202         final RpcResult<List<MultipartReply>> rpcResult = RpcResultBuilder
 203                 .<List<MultipartReply>>success()
 204                 .withResult(ofHeaderList)
 205                 .build();
 206         replyFuture.set(rpcResult);
 207         try {
 208             requestContext.close();
 209         } catch (final Exception e) {
 210             LOG.error("Closing RequestContext failed: ", e);
 211         }
 212     }
 213
 214     @Override
 215     public void processException(final Xid xid, final DeviceDataException deviceDataException) {
 216         final RequestContext requestContext = getRequests().get(xid.getValue());
 217
 218         final SettableFuture replyFuture = requestContext.getFuture();
 219         getRequests().remove(xid.getValue());
 220         final RpcResult<List<OfHeader>> rpcResult = RpcResultBuilder
 221                 .<List<OfHeader>>failed()
 222                 .withError(RpcError.ErrorType.APPLICATION, "Message processing failed", deviceDataException)
 223                 .build();
 224         replyFuture.set(rpcResult);
 225         try {
 226             requestContext.close();
 227         } catch (final Exception e) {
 228             LOG.error("Closing RequestContext failed: ", e);
 229         }
 230     }
 231
 232     @Override
 233     public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
 234         //TODO: will be defined later
 235     }
 236
 237     @Override
 238     public void processPortStatusMessage(final PortStatusMessage portStatus) {
 239         final TranslatorKey translatorKey = new TranslatorKey(portStatus.getVersion(), PortUpdateTranslator.class.getName());
 240         final MessageTranslator<PortStatusMessage, FlowCapableNodeConnector> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
 241         final FlowCapableNodeConnector nodeConnector = messageTranslator.translate(portStatus, this, null);
 242         //TODO write into datastore
 243     }
 244
 245     @Override
 246     public void processPacketInMessage(final PacketInMessage packetInMessage) {
 247         final TranslatorKey translatorKey = new TranslatorKey(packetInMessage.getVersion(), PacketReceivedTranslator.class.getName());
 248         final MessageTranslator<PacketInMessage, PacketReceived> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
 249         final PacketReceived packetReceived = messageTranslator.translate(packetInMessage, this, null);
 250         //TODO publish to MD-SAL
 251     }
 252
 253     @Override
 254     public TranslatorLibrary oook() {
 255         return translatorLibrary;
 256     }
 257
 258     @Override
 259     public void setTranslatorLibrary(final TranslatorLibrary translatorLibrary) {
 260         this.translatorLibrary = translatorLibrary;
 261     }
 262
 263
 264     private class XidGenerator {
 265
 266         private final AtomicLong xid = new AtomicLong(0);
 267
 268         public Xid generate() {
 269             return new Xid(xid.incrementAndGet());
 270         }
 271     }
 272 }