added requestMap access methods
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / device / DeviceContextImpl.java
index a195988e5f34291b8fad8c1518ab2dfa37f24205..b49773ac3f4a8b62ce1ff9e5e8582183ba723c33 100644 (file)
  */
 package org.opendaylight.openflowplugin.impl.device;
 
-import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
+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 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.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.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 java.math.BigInteger;
-import java.util.HashMap;
-import java.util.Map;
-import java.util.concurrent.Future;
+import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  *
  */
 public class DeviceContextImpl implements DeviceContext {
 
-    private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts = new HashMap<>();
+    private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
+
+    private final ConnectionContext primaryConnectionContext;
+    private final DeviceState deviceState;
+    private final DataBroker dataBroker;
+    private final XidGenerator xidGenerator;
+    private final HashedWheelTimer hashedWheelTimer;
+    private Map<Long, RequestContext> requests = new TreeMap<>();
+
+    private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
+    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<Class> messageSpy;
+
+
+    @VisibleForTesting
+    DeviceContextImpl(@Nonnull final ConnectionContext primaryConnectionContext,
+                      @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();
+        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
-    public <M extends ChildOf<DataObject>> void onMessage(M message, RequestContext requestContext) {
+    public <M extends ChildOf<DataObject>> void onMessage(final M message, final RequestContext requestContext) {
         // TODO Auto-generated method stub
 
     }
 
     @Override
-    public void addAuxiliaryConenctionContext(ConnectionContext connectionContext) {
-        SwitchConnectionDistinguisher connectionDistinguisher = new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
+    public void addAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
+        final SwitchConnectionDistinguisher connectionDistinguisher = new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
         auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
     }
 
     @Override
-    public void removeAuxiliaryConenctionContext(ConnectionContext connectionContext) {
+    public void removeAuxiliaryConenctionContext(final ConnectionContext connectionContext) {
         // TODO Auto-generated method stub
-
     }
 
     @Override
     public DeviceState getDeviceState() {
-        // TODO Auto-generated method stub
-        return null;
+        return deviceState;
     }
 
     @Override
-    public void setTransactionChain(TransactionChain transactionChain) {
-        // TODO Auto-generated method stub
+    public ReadTransaction getReadTransaction() {
+        return dataBroker.newReadOnlyTransaction();
+    }
 
+    @Override
+    public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
+                                                          final InstanceIdentifier<T> path, final T data) {
+        txChainManager.writeToTransaction(store, path, data);
     }
 
     @Override
-    public TransactionChain getTransactionChain() {
-        // TODO Auto-generated method stub
-        return null;
+    public <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path) {
+        txChainManager.addDeleteOperationTotTxChain(store, path);
     }
 
     @Override
@@ -75,7 +174,7 @@ public class DeviceContextImpl implements DeviceContext {
 
     @Override
     public ConnectionContext getPrimaryConnectionContext() {
-        return null;
+        return primaryConnectionContext;
     }
 
     @Override
@@ -85,13 +184,244 @@ public class DeviceContextImpl implements DeviceContext {
 
     @Override
     public Xid getNextXid() {
-        return null;
+        return xidGenerator.generate();
     }
 
     @Override
-    public <T extends DataObject> Future<RpcResult<T>> sendRequest(final DataObject dataObject) {
-        return null;
+    public RequestContext lookupRequest(Xid xid) {
+        return requests.get(xid.getValue());
+    }
+
+    @Override
+    public int getNumberOfOutstandingRequests() {
+        return requests.size();
+    }
+
+    @Override
+    public void hookRequestCtx(final Xid xid, final RequestContext requestFutureContext) {
+        requests.put(xid.getValue(), requestFutureContext);
+    }
+
+    @Override
+    public RequestContext unhookRequestCtx(Xid xid) {
+        return requests.remove(xid.getValue());
+    }
+
+    @Override
+    public void attachOpenflowMessageListener(final OpenflowMessageListenerFacade openflowMessageListenerFacade) {
+        this.openflowMessageListenerFacade = openflowMessageListenerFacade;
+        primaryConnectionContext.getConnectionAdapter().setMessageListener(openflowMessageListenerFacade);
+    }
+
+    @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 = requests.get(ofHeader.getXid());
+        if (null != requestContext) {
+            final SettableFuture replyFuture = requestContext.getFuture();
+            requests.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();
+                messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
+            } else {
+                rpcResult = RpcResultBuilder
+                        .<OfHeader>success()
+                        .withResult(ofHeader)
+                        .build();
+                messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
+            }
+
+            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: {}. From address: {}", ofHeader.getXid(), ofHeader.getClass().getName(),
+                    getPrimaryConnectionContext().getConnectionAdapter().getRemoteAddress());
+        }
     }
 
+    @Override
+    public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
+        final RequestContext requestContext = requests.get(xid.getValue());
+        if (null != requestContext) {
+            final SettableFuture replyFuture = requestContext.getFuture();
+            requests.remove(xid.getValue());
+            final RpcResult<List<MultipartReply>> rpcResult = RpcResultBuilder
+                    .<List<MultipartReply>>success()
+                    .withResult(ofHeaderList)
+                    .build();
+            replyFuture.set(rpcResult);
+            for (MultipartReply multipartReply : ofHeaderList) {
+                messageSpy.spyMessage(multipartReply.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
+            }
+
+            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 processException(final Xid xid, final DeviceDataException deviceDataException) {
+
+        LOG.trace("Processing exception for xid : {}", xid.getValue());
+
+        final RequestContext requestContext = requests.get(xid.getValue());
+
+        if (null != requestContext) {
+            final SettableFuture replyFuture = requestContext.getFuture();
+            requests.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);
+            messageSpy.spyMessage(deviceDataException.getClass(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
+            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(final FlowRemoved flowRemoved) {
+        //TODO: will be defined later
+    }
+
+    @Override
+    public void processPortStatusMessage(final PortStatusMessage portStatus) {
+        messageSpy.spyMessage(portStatus.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
+        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 processPacketInMessage(final PacketInMessage packetInMessage) {
+        messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
+        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 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;
+    }
+
+    @Override
+    public MessageSpy getMessageSpy() {
+        return messageSpy;
+    }
 }