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 java.math.BigInteger;
  11 import java.util.HashMap;
  12 import java.util.List;
  13 import java.util.Map;
  14 import java.util.concurrent.Future;
  15
  16 import javax.annotation.Nonnull;
  17
  18 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  19 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  20 import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
  21 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  22 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
  23 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
  24 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  25 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  26 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  27 import org.opendaylight.openflowplugin.api.openflow.device.DeviceReplyProcessor;
  28 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  29 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
  30 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  31 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
  32 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  33 import org.opendaylight.openflowplugin.api.openflow.device.XidGenerator;
  34 import org.opendaylight.openflowplugin.api.openflow.device.exception.DeviceDataException;
  35 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
  36 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
  37 import org.opendaylight.openflowplugin.api.openflow.md.util.OpenflowVersion;
  38 import org.opendaylight.openflowplugin.impl.device.translator.PacketReceivedTranslator;
  39 import org.opendaylight.openflowplugin.impl.device.translator.PortUpdateTranslator;
  40 import org.opendaylight.openflowplugin.openflow.md.core.session.SwitchConnectionCookieOFImpl;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
  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.OfHeader;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableFeatures;
  50 import org.opendaylight.yangtools.yang.binding.ChildOf;
  51 import org.opendaylight.yangtools.yang.binding.DataObject;
  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 import com.google.common.annotations.VisibleForTesting;
  59 import com.google.common.base.Preconditions;
  60 import com.google.common.util.concurrent.SettableFuture;
  61
  62 /**
  63  *
  64  */
  65 public class DeviceContextImpl implements DeviceContext, DeviceReplyProcessor, TransactionChainListener {
  66
  67     private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
  68
  69     private final ConnectionContext primaryConnectionContext;
  70     private final DeviceState deviceState;
  71     private final DataBroker dataBroker;
  72     private final XidGenerator xidGenerator;
  73     private Map<Long, RequestContext> requests =
  74             new HashMap<Long, RequestContext>();
  75
  76     private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
  77     private BindingTransactionChain txChainFactory;
  78     private TranslatorLibrary translatorLibrary;
  79
  80     @VisibleForTesting
  81     DeviceContextImpl(@Nonnull final ConnectionContext primaryConnectionContext,
  82                       @Nonnull final DeviceState deviceState, @Nonnull final DataBroker dataBroker) {
  83         this.primaryConnectionContext = Preconditions.checkNotNull(primaryConnectionContext);
  84         this.deviceState = Preconditions.checkNotNull(deviceState);
  85         this.dataBroker = Preconditions.checkNotNull(dataBroker);
  86         xidGenerator = new XidGenerator();
  87         txChainFactory = dataBroker.createTransactionChain(DeviceContextImpl.this);
  88         auxiliaryConnectionContexts = new HashMap<>();
  89         requests = new HashMap<>();
  90     }
  91
  92     @Override
  93     public <M extends ChildOf<DataObject>> void onMessage(final M message, final RequestContext requestContext) {
  94         // TODO Auto-generated method stub
  95
  96     }
  97
  98     @Override
  99     public void addAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 100         final SwitchConnectionDistinguisher connectionDistinguisher = new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
 101         auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
 102     }
 103
 104     @Override
 105     public void removeAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
 106         // TODO Auto-generated method stub
 107
 108     }
 109
 110     @Override
 111     public DeviceState getDeviceState() {
 112         return deviceState;
 113     }
 114
 115     @Override
 116     public ReadTransaction getReadTransaction() {
 117         return dataBroker.newReadOnlyTransaction();
 118     }
 119
 120     @Override
 121     public WriteTransaction getWriteTransaction() {
 122         // FIXME : we wana to have only one WriteTransaction exposed in one time
 123         // so thing about blocking notification mechanism for wait to new transaction
 124         return txChainFactory.newWriteOnlyTransaction();
 125     }
 126
 127     @Override
 128     public TableFeatures getCapabilities() {
 129         // TODO Auto-generated method stub
 130         return null;
 131     }
 132
 133     @Override
 134     public ConnectionContext getPrimaryConnectionContext() {
 135         return primaryConnectionContext;
 136     }
 137
 138     @Override
 139     public ConnectionContext getAuxiliaryConnectiobContexts(final BigInteger cookie) {
 140         return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
 141     }
 142
 143     @Override
 144     public Xid getNextXid() {
 145         return xidGenerator.generate();
 146     }
 147
 148     public Map<Long, RequestContext> getRequests() {
 149         return requests;
 150     }
 151
 152     @Override
 153     public void hookRequestCtx(Xid xid, RequestContext requestFutureContext) {
 154         // TODO Auto-generated method stub
 155         requests.put(xid.getValue(), requestFutureContext);
 156     }
 157
 158     @Override
 159     public void processReply(OfHeader ofHeader) {
 160         RequestContext requestContext = getRequests().get(ofHeader.getXid());
 161         SettableFuture replyFuture = requestContext.getFuture();
 162         getRequests().remove(ofHeader.getXid());
 163         RpcResult<OfHeader> rpcResult;
 164
 165         if(ofHeader instanceof Error) {
 166             Error error = (Error) ofHeader;
 167             String message = "Operation on device failed";
 168             rpcResult= RpcResultBuilder
 169                     .<OfHeader>failed()
 170                     .withError(RpcError.ErrorType.APPLICATION, message, new DeviceDataException(message, error))
 171                     .build();
 172         } else {
 173             rpcResult= RpcResultBuilder
 174                     .<OfHeader>success()
 175                     .withResult(ofHeader)
 176                     .build();
 177         }
 178
 179         replyFuture.set(rpcResult);
 180         try {
 181             requestContext.close();
 182         } catch (Exception e) {
 183             LOG.error("Closing RequestContext failed: ", e);
 184         }
 185     }
 186
 187     @Override
 188     public void processReply(Xid xid, List<OfHeader> ofHeaderList) {
 189         RequestContext requestContext = getRequests().get(xid.getValue());
 190         SettableFuture replyFuture = requestContext.getFuture();
 191         getRequests().remove(xid.getValue());
 192         RpcResult<List<OfHeader>> rpcResult= RpcResultBuilder
 193                                                 .<List<OfHeader>>success()
 194                                                 .withResult(ofHeaderList)
 195                                                 .build();
 196         replyFuture.set(rpcResult);
 197         try {
 198             requestContext.close();
 199         } catch (Exception e) {
 200             LOG.error("Closing RequestContext failed: ", e);
 201         }
 202     }
 203
 204     @Override
 205     public void processException(Xid xid, DeviceDataException deviceDataException) {
 206         RequestContext requestContext = getRequests().get(xid.getValue());
 207
 208         SettableFuture replyFuture = requestContext.getFuture();
 209         getRequests().remove(xid.getValue());
 210         RpcResult<List<OfHeader>> rpcResult= RpcResultBuilder
 211                 .<List<OfHeader>>failed()
 212                 .withError(RpcError.ErrorType.APPLICATION, "Message processing failed", deviceDataException)
 213                 .build();
 214         replyFuture.set(rpcResult);
 215         try {
 216             requestContext.close();
 217         } catch (Exception e) {
 218             LOG.error("Closing RequestContext failed: ", e);
 219         }
 220     }
 221
 222     @Override
 223     public void processFlowRemovedMessage(FlowRemoved flowRemoved) {
 224         //TODO: will be defined later
 225     }
 226
 227     @Override
 228     public void processPortStatusMessage(PortStatusMessage portStatus) {
 229         TranslatorKey translatorKey = new TranslatorKey(portStatus.getVersion(), PortUpdateTranslator.class.getName());
 230         MessageTranslator<PortStatusMessage, FlowCapableNodeConnector> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
 231         FlowCapableNodeConnector nodeConnector = messageTranslator.translate(portStatus, this, null);
 232         //TODO write into datastore
 233     }
 234
 235     @Override
 236     public void processPacketInMessage(PacketInMessage packetInMessage) {
 237         TranslatorKey translatorKey = new TranslatorKey(packetInMessage.getVersion(), PacketReceivedTranslator.class.getName());
 238         MessageTranslator<PacketInMessage, PacketReceived> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
 239         PacketReceived packetReceived = messageTranslator.translate(packetInMessage, this, null);
 240         //TODO publish to MD-SAL
 241     }
 242
 243     @Override
 244     public void onTransactionChainFailed(TransactionChain<?, ?> chain,
 245             AsyncTransaction<?, ?> transaction, Throwable cause) {
 246         txChainFactory.close();
 247         txChainFactory = dataBroker.createTransactionChain(DeviceContextImpl.this);
 248
 249     }
 250
 251     @Override
 252     public void onTransactionChainSuccessful(TransactionChain<?, ?> chain) {
 253      // NOOP - only yet, here is probably place for notification to get new WriteTransaction
 254
 255     }
 256
 257     public void setTranslatorLibrary(TranslatorLibrary translatorLibrary) {
 258         this.translatorLibrary = translatorLibrary;
 259     }
 260 }