DeviceContexts holds referrence to message spy counter
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / device / DeviceContextImpl.java
index d4595e06f8bee6a17fc05756e1ee90edf7016e1b..e6389ac342fe923e5494e03e143b5e7bc6367b3b 100644 (file)
@@ -10,40 +10,73 @@ 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 org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
+import io.netty.util.HashedWheelTimer;
+import io.netty.util.Timeout;
+import java.math.BigInteger;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.TreeMap;
+import java.util.concurrent.atomic.AtomicLong;
+import javax.annotation.Nonnull;
 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.controller.sal.binding.api.NotificationProviderService;
 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.OpenflowMessageListenerFacade;
 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
+import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
+import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
+import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
+import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
+import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
+import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
+import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
+import org.opendaylight.openflowplugin.impl.registry.group.DeviceGroupRegistryImpl;
+import org.opendaylight.openflowplugin.impl.registry.meter.DeviceMeterRegistryImpl;
 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.inventory.rev130819.NodeConnectorId;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortReason;
 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.PacketIn;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
+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.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
 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.binding.KeyedInstanceIdentifier;
 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 javax.annotation.Nonnull;
-import java.math.BigInteger;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.concurrent.Future;
-
 /**
  *
  */
-public class DeviceContextImpl implements DeviceContext, DeviceReplyProcessor, TransactionChainListener {
+public class DeviceContextImpl implements DeviceContext {
 
     private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
 
@@ -51,22 +84,48 @@ 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 OpenflowMessageListenerFacade openflowMessageListenerFacade;
+    private final DeviceFlowRegistry deviceFlowRegistry;
+    private final DeviceGroupRegistry deviceGroupRegistry;
+    private final DeviceMeterRegistry deviceMeterRegistry;
+    private Timeout barrierTaskTimeout;
+    private NotificationProviderService notificationService;
+    private final MessageSpy messageSpy;
+
 
     @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,
+                      @Nonnull final MessageSpy _messageSpy) {
         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, hashedWheelTimer, 500L);
         auxiliaryConnectionContexts = new HashMap<>();
         requests = new HashMap<>();
+        deviceFlowRegistry = new DeviceFlowRegistryImpl();
+        deviceGroupRegistry = new DeviceGroupRegistryImpl();
+        deviceMeterRegistry = new DeviceMeterRegistryImpl();
+        messageSpy = _messageSpy;
+    }
+
+    /**
+     * 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();
     }
 
     @Override
@@ -84,7 +143,6 @@ public class DeviceContextImpl implements DeviceContext, DeviceReplyProcessor, T
     @Override
     public void removeAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
         // TODO Auto-generated method stub
-
     }
 
     @Override
@@ -98,10 +156,14 @@ 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
+    public <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path) {
+        txChainManager.addDeleteOperationTotTxChain(store, path);
     }
 
     @Override
@@ -125,92 +187,218 @@ public class DeviceContextImpl implements DeviceContext, DeviceReplyProcessor, T
         return xidGenerator.generate();
     }
 
+    @Override
     public Map<Long, RequestContext> getRequests() {
         return requests;
     }
 
     @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 attachOpenflowMessageListener(final OpenflowMessageListenerFacade openflowMessageListenerFacade) {
+        this.openflowMessageListenerFacade = openflowMessageListenerFacade;
+        primaryConnectionContext.getConnectionAdapter().setMessageListener(openflowMessageListenerFacade);
+    }
 
-        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();
+    @Override
+    public OpenflowMessageListenerFacade getOpenflowMessageListenerFacade() {
+        return openflowMessageListenerFacade;
+    }
+
+    @Override
+    public DeviceFlowRegistry getDeviceFlowRegistry() {
+        return deviceFlowRegistry;
+    }
+
+    @Override
+    public DeviceGroupRegistry getDeviceGroupRegistry() {
+        return deviceGroupRegistry;
+    }
+
+    @Override
+    public DeviceMeterRegistry getDeviceMeterRegistry() {
+        return deviceMeterRegistry;
+    }
+
+    @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 {
-            rpcResult= RpcResultBuilder
-                    .<OfHeader>success()
-                    .withResult(ofHeader)
-                    .build();
+            LOG.error("Can't find request context registered for xid : {}. Type of reply: {}. From address: {}", ofHeader.getXid(), ofHeader.getClass().getName(),
+                    getPrimaryConnectionContext().getConnectionAdapter().getRemoteAddress());
         }
+    }
 
-        replyFuture.set(rpcResult);
-        try {
-            requestContext.close();
-        } catch (Exception e) {
-            LOG.error("Closing RequestContext failed: ", e);
+    @Override
+    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 : {}. Type of reply: MULTIPART. From address: {}", xid.getValue(),
+                    getPrimaryConnectionContext().getConnectionAdapter().getRemoteAddress());
         }
     }
 
     @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 processException(final Xid xid, final DeviceDataException deviceDataException) {
+
+        LOG.trace("Processing exception for xid : {}", xid.getValue());
+
+        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 processException(Xid xid, DeviceDataException deviceDataException) {
-        RequestContext requestContext = getRequests().get(xid.getValue());
+    public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
+        //TODO: will be defined later
+    }
 
-        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);
+    @Override
+    public void processPortStatusMessage(final PortStatusMessage portStatus) {
+        final TranslatorKey translatorKey = new TranslatorKey(portStatus.getVersion(), PortGrouping.class.getName());
+        final MessageTranslator<PortGrouping, FlowCapableNodeConnector> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
+        final FlowCapableNodeConnector flowCapableNodeConnector = messageTranslator.translate(portStatus, this, null);
+
+        final KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> iiToNodeConnector = provideIIToNodeConnector(portStatus.getPortNo(), portStatus.getVersion());
+        if (portStatus.getReason().equals(PortReason.OFPPRADD) || portStatus.getReason().equals(PortReason.OFPPRMODIFY)) {
+            // because of ADD status node connector has to be created
+            final NodeConnectorBuilder nConnectorBuilder = new NodeConnectorBuilder().setKey(iiToNodeConnector.getKey());
+            nConnectorBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
+            nConnectorBuilder.addAugmentation(FlowCapableNodeConnector.class, flowCapableNodeConnector);
+            writeToTransaction(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector, nConnectorBuilder.build());
+        } else if (portStatus.getReason().equals(PortReason.OFPPRDELETE)) {
+            addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector);
         }
     }
 
+    private KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> provideIIToNodeConnector(final long portNo, final short version) {
+        final InstanceIdentifier<Node> iiToNodes = deviceState.getNodeInstanceIdentifier();
+        final BigInteger dataPathId = deviceState.getFeatures().getDatapathId();
+        final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), portNo, version);
+        return iiToNodes.child(NodeConnector.class, new NodeConnectorKey(nodeConnectorId));
+    }
+
     @Override
-    public void onTransactionChainFailed(TransactionChain<?, ?> chain,
-            AsyncTransaction<?, ?> transaction, Throwable cause) {
-        txChainFactory.close();
-        txChainFactory = dataBroker.createTransactionChain(DeviceContextImpl.this);
+    public void processPacketInMessage(final PacketInMessage packetInMessage) {
+        final TranslatorKey translatorKey = new TranslatorKey(packetInMessage.getVersion(), PacketIn.class.getName());
+        final MessageTranslator<PacketInMessage, PacketReceived> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
+        final PacketReceived packetReceived = messageTranslator.translate(packetInMessage, this, null);
+        notificationService.publish(packetReceived);
+    }
 
+    @Override
+    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;
+    }
 
+    @Override
+    public HashedWheelTimer getTimer() {
+        return hashedWheelTimer;
+    }
+
+    @Override
+    public void close() throws Exception {
+        for (Map.Entry<Long, RequestContext> entry : requests.entrySet()){
+            entry.getValue().close();
+        }
     }
 
+
+    private class XidGenerator {
+
+        private final AtomicLong xid = new AtomicLong(0);
+
+        public Xid generate() {
+            return new Xid(xid.incrementAndGet());
+        }
+    }
+
+    @Override
+    public RequestContext extractNextOutstandingMessage(final long barrierXid) {
+        RequestContext nextMessage = null;
+        final Iterator<Long> keyIterator = requests.keySet().iterator();
+        if (keyIterator.hasNext()) {
+            final Long oldestXid = keyIterator.next();
+            if (oldestXid < barrierXid) {
+                nextMessage = requests.remove(oldestXid);
+            }
+        }
+        return nextMessage;
+    }
+
+    @Override
+    public void setCurrentBarrierTimeout(final Timeout timeout) {
+        barrierTaskTimeout = timeout;
+    }
+
+    @Override
+    public Timeout getBarrierTaskTimeout() {
+        return barrierTaskTimeout;
+    }
+
+    @Override
+    public void setNotificationService(final NotificationProviderService notificationServiceParam) {
+        notificationService = notificationServiceParam;
+    }
 }