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