org.opendaylight.netvirt.natservice.internal.NaptFlowRemovedEventHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of natservice-impl Show documentation
There is a newer version: 0.11.4
/*
 * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.netvirt.natservice.internal;

import java.math.BigInteger;
import javax.inject.Inject;
import javax.inject.Singleton;
import org.opendaylight.genius.mdsalutil.MetaDataUtil;
import org.opendaylight.genius.mdsalutil.NwConstants;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowAdded;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowUpdated;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.NodeErrorNotification;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.NodeExperimenterErrorNotification;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowListener;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SwitchFlowRemoved;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.RemovedFlowReason;
import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.TcpMatchFields;
import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.UdpMatchFields;
import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Layer3Match;
import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Layer4Match;
import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4Match;
import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.TcpMatch;
import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.UdpMatch;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@Singleton
public class NaptFlowRemovedEventHandler implements SalFlowListener {
    private static final Logger LOG = LoggerFactory.getLogger(NaptFlowRemovedEventHandler.class);

    private final EventDispatcher naptEventdispatcher;

    @Inject
    public NaptFlowRemovedEventHandler(final EventDispatcher eventDispatcher) {
        this.naptEventdispatcher = eventDispatcher;
    }

    @Override
    public void onSwitchFlowRemoved(SwitchFlowRemoved flowRemoved) {

    }

    @Override
    public void onFlowAdded(FlowAdded arg0) {
        // TODO Auto-generated method stub

    }

    @Override
    public void onFlowRemoved(FlowRemoved flowRemoved) {
        /*
        If the removed flow is from the OUTBOUND NAPT table :
        1) Get the ActionInfo of the flow.
        2) From the ActionInfo of the flow get the internal IP address, port and the protocol.
        3) Get the Metadata matching info of the flow.
        4) From the Metadata matching info of the flow get router ID.
        5) Querry the container intext-ip-port-map using the router ID
           and the internal IP address, port to get the external IP address, port
        6) Instantiate an NaptEntry event and populate the external IP address, port and the router ID.
        7) Place the NaptEntry event to the queue.
*/

        short tableId = flowRemoved.getTableId();
        RemovedFlowReason removedReasonFlag = flowRemoved.getReason();
        if (tableId == NwConstants.OUTBOUND_NAPT_TABLE
                && RemovedFlowReason.OFPRRIDLETIMEOUT.equals(removedReasonFlag)) {
            LOG.info("onFlowRemoved : triggered for table-{} entry", tableId);

            //Get the internal internal IP address and the port number from the IPv4 match.
            Ipv4Prefix internalIpv4Address = null;
            Layer3Match layer3Match = flowRemoved.getMatch().getLayer3Match();
            if (layer3Match instanceof Ipv4Match) {
                Ipv4Match internalIpv4Match = (Ipv4Match) layer3Match;
                internalIpv4Address = internalIpv4Match.getIpv4Source();
            }
            if (internalIpv4Address == null) {
                LOG.error("onFlowRemoved : Matching internal IP is null while retrieving the "
                    + "value from the Outbound NAPT flow");
                return;
            }
            //Get the internal IP as a string
            String internalIpv4AddressAsString = internalIpv4Address.getValue();
            String[] internalIpv4AddressParts = internalIpv4AddressAsString.split("/");
            String internalIpv4HostAddress = null;
            if (internalIpv4AddressParts.length >= 1) {
                internalIpv4HostAddress = internalIpv4AddressParts[0];
            }

            //Get the protocol from the layer4 match
            NAPTEntryEvent.Protocol protocol = null;
            Integer internalPortNumber = null;
            Layer4Match layer4Match = flowRemoved.getMatch().getLayer4Match();
            if (layer4Match instanceof TcpMatch) {
                TcpMatchFields tcpMatchFields = (TcpMatchFields) layer4Match;
                internalPortNumber = tcpMatchFields.getTcpSourcePort().getValue();
                protocol = NAPTEntryEvent.Protocol.TCP;
            } else if (layer4Match instanceof UdpMatch) {
                UdpMatchFields udpMatchFields = (UdpMatchFields) layer4Match;
                internalPortNumber = udpMatchFields.getUdpSourcePort().getValue();
                protocol = NAPTEntryEvent.Protocol.UDP;
            }
            if (protocol == null) {
                LOG.error("onFlowRemoved : Matching protocol is null while retrieving the value "
                    + "from the Outbound NAPT flow");
                return;
            }

            //Get the router ID from the metadata.
            Long routerId;
            BigInteger metadata = flowRemoved.getMatch().getMetadata().getMetadata();
            if (MetaDataUtil.getNatRouterIdFromMetadata(metadata) != 0) {
                routerId = MetaDataUtil.getNatRouterIdFromMetadata(metadata);
            } else {
                LOG.error("onFlowRemoved : Null exception while retrieving routerId");
                return;
            }
            String flowDpn = NatUtil.getDpnFromNodeRef(flowRemoved.getNode());
            NAPTEntryEvent naptEntryEvent = new NAPTEntryEvent(internalIpv4HostAddress, internalPortNumber, flowDpn,
                routerId, NAPTEntryEvent.Operation.DELETE, protocol);
            naptEventdispatcher.addFlowRemovedNaptEvent(naptEntryEvent);
        } else {
            LOG.debug("onFlowRemoved : Received flow removed notification due to flowdelete from switch for flowref");
        }

    }

    @Override
    public void onFlowUpdated(FlowUpdated arg0) {
        // TODO Auto-generated method stub

    }

    @Override
    public void onNodeErrorNotification(NodeErrorNotification arg0) {
        // TODO Auto-generated method stub
    }

    @Override
    public void onNodeExperimenterErrorNotification(NodeExperimenterErrorNotification arg0) {
        // TODO Auto-generated method stub
    }
}