device context provides attached any messege type listener
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / device / DeviceContextImpl.java
index 2203b65b313b7c47f8705d224683cc5c6555eff5..c797107668ad8da38124507f27e8861a17cad4c8 100644 (file)
@@ -7,51 +7,59 @@
  */
 package org.opendaylight.openflowplugin.impl.device;
 
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Preconditions;
+import com.google.common.util.concurrent.SettableFuture;
+import io.netty.util.HashedWheelTimer;
+import io.netty.util.Timeout;
+import io.netty.util.TimerTask;
 import java.math.BigInteger;
 import java.util.HashMap;
+import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
-import java.util.concurrent.Future;
-
+import java.util.TreeMap;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicLong;
 import javax.annotation.Nonnull;
-
-import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
 import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
-import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
-import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
-import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
-import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
+import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
-import org.opendaylight.openflowplugin.api.openflow.device.*;
+import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
+import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
+import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
+import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
+import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
+import org.opendaylight.openflowplugin.api.openflow.device.Xid;
 import org.opendaylight.openflowplugin.api.openflow.device.exception.DeviceDataException;
+import org.opendaylight.openflowplugin.api.openflow.device.listener.AnyMessageTypeListener;
 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
-import org.opendaylight.openflowplugin.api.openflow.md.util.OpenflowVersion;
-import org.opendaylight.openflowplugin.impl.device.translator.PacketReceivedTranslator;
-import org.opendaylight.openflowplugin.impl.device.translator.PortUpdateTranslator;
+import org.opendaylight.openflowplugin.impl.translator.PacketReceivedTranslator;
 import org.opendaylight.openflowplugin.openflow.md.core.session.SwitchConnectionCookieOFImpl;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.*;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableFeatures;
 import org.opendaylight.yangtools.yang.binding.ChildOf;
 import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.opendaylight.yangtools.yang.common.RpcError;
 import org.opendaylight.yangtools.yang.common.RpcResult;
 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.google.common.annotations.VisibleForTesting;
-import com.google.common.base.Preconditions;
-import com.google.common.util.concurrent.SettableFuture;
-
 /**
  *
  */
-public class DeviceContextImpl implements DeviceContext, DeviceReplyProcessor, TransactionChainListener {
+public class DeviceContextImpl implements DeviceContext {
 
     private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
 
@@ -59,25 +67,43 @@ public class DeviceContextImpl implements DeviceContext, DeviceReplyProcessor, T
     private final DeviceState deviceState;
     private final DataBroker dataBroker;
     private final XidGenerator xidGenerator;
-    private Map<Long, RequestContext> requests =
-            new HashMap<Long, RequestContext>();
+    private final HashedWheelTimer hashedWheelTimer;
+    private Map<Long, RequestContext> requests = new TreeMap<>();
 
     private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
-    private BindingTransactionChain txChainFactory;
+    private final TransactionChainManager txChainManager;
     private TranslatorLibrary translatorLibrary;
+    private AnyMessageTypeListener anyMessageTypeListener;
 
     @VisibleForTesting
     DeviceContextImpl(@Nonnull final ConnectionContext primaryConnectionContext,
-                      @Nonnull final DeviceState deviceState, @Nonnull final DataBroker dataBroker) {
+                      @Nonnull final DeviceState deviceState, @Nonnull final DataBroker dataBroker,
+                      @Nonnull final HashedWheelTimer hashedWheelTimer) {
         this.primaryConnectionContext = Preconditions.checkNotNull(primaryConnectionContext);
         this.deviceState = Preconditions.checkNotNull(deviceState);
         this.dataBroker = Preconditions.checkNotNull(dataBroker);
+        this.hashedWheelTimer = Preconditions.checkNotNull(hashedWheelTimer);
         xidGenerator = new XidGenerator();
-        txChainFactory = dataBroker.createTransactionChain(DeviceContextImpl.this);
+        txChainManager = new TransactionChainManager(dataBroker, 500L);
         auxiliaryConnectionContexts = new HashMap<>();
         requests = new HashMap<>();
     }
 
+    /**
+     * This method is called from {@link DeviceManagerImpl} only. So we could say "posthandshake process finish"
+     * and we are able to set a scheduler for an automatic transaction submitting by time (0,5sec).
+     */
+    void submitTransaction() {
+        txChainManager.submitTransaction();
+        txChainManager.enableCounter();
+        hashedWheelTimer.newTimeout(new TimerTask() {
+            @Override
+            public void run(final Timeout timeout) throws Exception {
+                submitTransaction();
+            }
+        }, 0, TimeUnit.MILLISECONDS);
+    }
+
     @Override
     public <M extends ChildOf<DataObject>> void onMessage(final M message, final RequestContext requestContext) {
         // TODO Auto-generated method stub
@@ -93,7 +119,6 @@ public class DeviceContextImpl implements DeviceContext, DeviceReplyProcessor, T
     @Override
     public void removeAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
         // TODO Auto-generated method stub
-
     }
 
     @Override
@@ -107,10 +132,9 @@ public class DeviceContextImpl implements DeviceContext, DeviceReplyProcessor, T
     }
 
     @Override
-    public WriteTransaction getWriteTransaction() {
-        // FIXME : we wana to have only one WriteTransaction exposed in one time
-        // so thing about blocking notification mechanism for wait to new transaction
-        return txChainFactory.newWriteOnlyTransaction();
+    public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
+                                                          final InstanceIdentifier<T> path, final T data) {
+        txChainManager.writeToTransaction(store, path, data);
     }
 
     @Override
@@ -139,111 +163,151 @@ public class DeviceContextImpl implements DeviceContext, DeviceReplyProcessor, T
     }
 
     @Override
-    public void hookRequestCtx(Xid xid, RequestContext requestFutureContext) {
+    public void hookRequestCtx(final Xid xid, final RequestContext requestFutureContext) {
         // TODO Auto-generated method stub
         requests.put(xid.getValue(), requestFutureContext);
     }
 
     @Override
-    public void processReply(OfHeader ofHeader) {
-        RequestContext requestContext = getRequests().get(ofHeader.getXid());
-        SettableFuture replyFuture = requestContext.getFuture();
-        getRequests().remove(ofHeader.getXid());
-        RpcResult<OfHeader> rpcResult;
+    public void attachAnyMessageTypeListener(final AnyMessageTypeListener anyMessageTypeListener) {
+        this.anyMessageTypeListener = anyMessageTypeListener;
+        primaryConnectionContext.getConnectionAdapter().setMessageListener(anyMessageTypeListener);
+    }
 
-        if(ofHeader instanceof Error) {
-            Error error = (Error) ofHeader;
-            String message = "Operation on device failed";
-            rpcResult= RpcResultBuilder
-                    .<OfHeader>failed()
-                    .withError(RpcError.ErrorType.APPLICATION, message, new DeviceDataException(message, error))
-                    .build();
-        } else {
-            rpcResult= RpcResultBuilder
-                    .<OfHeader>success()
-                    .withResult(ofHeader)
-                    .build();
-        }
+    @Override
+    public AnyMessageTypeListener getAnyMessageTypeListener() {
+        return this.anyMessageTypeListener;
+    }
 
-        replyFuture.set(rpcResult);
-        try {
-            requestContext.close();
-        } catch (Exception e) {
-            LOG.error("Closing RequestContext failed: ", e);
+    @Override
+    public void processReply(final OfHeader ofHeader) {
+        final RequestContext requestContext = getRequests().get(ofHeader.getXid());
+        if (null != requestContext) {
+            final SettableFuture replyFuture = requestContext.getFuture();
+            getRequests().remove(ofHeader.getXid());
+            RpcResult<OfHeader> rpcResult;
+            if (ofHeader instanceof Error) {
+                final Error error = (Error) ofHeader;
+                final String message = "Operation on device failed";
+                rpcResult = RpcResultBuilder
+                        .<OfHeader>failed()
+                        .withError(RpcError.ErrorType.APPLICATION, message, new DeviceDataException(message, error))
+                        .build();
+            } else {
+                rpcResult = RpcResultBuilder
+                        .<OfHeader>success()
+                        .withResult(ofHeader)
+                        .build();
+            }
+
+            replyFuture.set(rpcResult);
+            try {
+                requestContext.close();
+            } catch (final Exception e) {
+                LOG.error("Closing RequestContext failed: ", e);
+            }
+        } else {
+            LOG.error("Can't find request context registered for xid : {}", ofHeader.getXid());
         }
     }
 
     @Override
-    public void processReply(Xid xid, List<OfHeader> ofHeaderList) {
-        RequestContext requestContext = getRequests().get(xid.getValue());
-        SettableFuture replyFuture = requestContext.getFuture();
-        getRequests().remove(xid.getValue());
-        RpcResult<List<OfHeader>> rpcResult= RpcResultBuilder
-                                                .<List<OfHeader>>success()
-                                                .withResult(ofHeaderList)
-                                                .build();
-        replyFuture.set(rpcResult);
-        try {
-            requestContext.close();
-        } catch (Exception e) {
-            LOG.error("Closing RequestContext failed: ", e);
+    public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
+        final RequestContext requestContext = getRequests().get(xid.getValue());
+        if (null != requestContext) {
+            final SettableFuture replyFuture = requestContext.getFuture();
+            getRequests().remove(xid.getValue());
+            final RpcResult<List<MultipartReply>> rpcResult = RpcResultBuilder
+                    .<List<MultipartReply>>success()
+                    .withResult(ofHeaderList)
+                    .build();
+            replyFuture.set(rpcResult);
+            try {
+                requestContext.close();
+            } catch (final Exception e) {
+                LOG.error("Closing RequestContext failed: ", e);
+            }
+        } else {
+            LOG.error("Can't find request context registered for xid : {}", xid.getValue());
         }
     }
 
     @Override
-    public void processException(Xid xid, DeviceDataException deviceDataException) {
-        RequestContext requestContext = getRequests().get(xid.getValue());
+    public void processException(final Xid xid, final DeviceDataException deviceDataException) {
+
+        LOG.trace("Processing exception for xid : {}", xid.getValue());
 
-        SettableFuture replyFuture = requestContext.getFuture();
-        getRequests().remove(xid.getValue());
-        RpcResult<List<OfHeader>> rpcResult= RpcResultBuilder
-                .<List<OfHeader>>failed()
-                .withError(RpcError.ErrorType.APPLICATION, "Message processing failed", deviceDataException)
-                .build();
-        replyFuture.set(rpcResult);
-        try {
-            requestContext.close();
-        } catch (Exception e) {
-            LOG.error("Closing RequestContext failed: ", e);
+        final RequestContext requestContext = getRequests().get(xid.getValue());
+
+        if (null != requestContext) {
+            final SettableFuture replyFuture = requestContext.getFuture();
+            getRequests().remove(xid.getValue());
+            final RpcResult<List<OfHeader>> rpcResult = RpcResultBuilder
+                    .<List<OfHeader>>failed()
+                    .withError(RpcError.ErrorType.APPLICATION, String.format("Message processing failed : %s", deviceDataException.getError()), deviceDataException)
+                    .build();
+            replyFuture.set(rpcResult);
+            try {
+                requestContext.close();
+            } catch (final Exception e) {
+                LOG.error("Closing RequestContext failed: ", e);
+            }
+        } else {
+            LOG.error("Can't find request context registered for xid : {}", xid.getValue());
         }
     }
 
     @Override
-    public void processFlowRemovedMessage(FlowRemoved flowRemoved) {
+    public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
         //TODO: will be defined later
     }
 
     @Override
-    public void processPortStatusMessage(PortStatusMessage portStatus) {
-        TranslatorKey translatorKey = new TranslatorKey(portStatus.getVersion(), PortUpdateTranslator.class.getName());
-        MessageTranslator<PortStatusMessage, FlowCapableNodeConnector> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
-        FlowCapableNodeConnector nodeConnector = messageTranslator.translate(portStatus, this, null);
+    public void processPortStatusMessage(final PortStatusMessage portStatus) {
+        final TranslatorKey translatorKey = new TranslatorKey(portStatus.getVersion(), PortStatusMessage.class.getName());
+        final MessageTranslator<PortStatusMessage, FlowCapableNodeConnector> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
+        final FlowCapableNodeConnector nodeConnector = messageTranslator.translate(portStatus, this, null);
         //TODO write into datastore
     }
 
     @Override
-    public void processPacketInMessage(PacketInMessage packetInMessage) {
-        TranslatorKey translatorKey = new TranslatorKey(packetInMessage.getVersion(), PacketReceivedTranslator.class.getName());
-        MessageTranslator<PacketInMessage, PacketReceived> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
-        PacketReceived packetReceived = messageTranslator.translate(packetInMessage, this, null);
+    public void processPacketInMessage(final PacketInMessage packetInMessage) {
+        final TranslatorKey translatorKey = new TranslatorKey(packetInMessage.getVersion(), PacketReceivedTranslator.class.getName());
+        final MessageTranslator<PacketInMessage, PacketReceived> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
+        final PacketReceived packetReceived = messageTranslator.translate(packetInMessage, this, null);
         //TODO publish to MD-SAL
     }
 
     @Override
-    public void onTransactionChainFailed(TransactionChain<?, ?> chain,
-            AsyncTransaction<?, ?> transaction, Throwable cause) {
-        txChainFactory.close();
-        txChainFactory = dataBroker.createTransactionChain(DeviceContextImpl.this);
-
+    public TranslatorLibrary oook() {
+        return translatorLibrary;
     }
 
     @Override
-    public void onTransactionChainSuccessful(TransactionChain<?, ?> chain) {
-     // NOOP - only yet, here is probably place for notification to get new WriteTransaction
+    public void setTranslatorLibrary(final TranslatorLibrary translatorLibrary) {
+        this.translatorLibrary = translatorLibrary;
+    }
+
+
+    private class XidGenerator {
+
+        private final AtomicLong xid = new AtomicLong(0);
 
+        public Xid generate() {
+            return new Xid(xid.incrementAndGet());
+        }
     }
 
-    public void setTranslatorLibrary(TranslatorLibrary translatorLibrary) {
-        this.translatorLibrary = translatorLibrary;
+    @Override
+    public RequestContext extractNextOutstandingMessage(long barrierXid) {
+        RequestContext nextMessage = null;
+        Iterator<Long> keyIterator = requests.keySet().iterator();
+        if (keyIterator.hasNext()) {
+            Long oldestXid = keyIterator.next();
+            if (oldestXid < barrierXid) {
+                nextMessage = requests.remove(oldestXid);
+            }
+        }
+        return nextMessage;
     }
 }