org.opendaylight.netvirt.cloudservicechain.utils

Class VpnServiceChainUtils

java.lang.Object

org.opendaylight.netvirt.cloudservicechain.utils.VpnServiceChainUtils

public class VpnServiceChainUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
VpnServiceChainUtils()

Method Summary

Modifier and Type	Method and Description
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices>	buildBoundServicesIid(short servicePrio, String ifaceName)
static org.opendaylight.genius.mdsalutil.FlowEntity	buildLFibVpnPseudoPortFlow(BigInteger dpId, Long label, String nextHop, int lportTag) Builds a Flow for the LFIB table that sets the LPortTag of the VpnPseudoPort and sends to LPortDispatcher table.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow	buildLPortDispFlowForVpntoVpn(Integer dstLportTag, Integer vpnTag) Creates a Flow that does the trick of moving the packets from one VPN to another VPN.
static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow	buildLPortDispFromScfToL3VpnFlow(Long vpnId, BigInteger dpId, Integer lportTag, int addOrRemove) Build the flow that must be inserted when there is a ScHop whose egressPort is a VPN Pseudo Port.
static org.opendaylight.genius.mdsalutil.FlowEntity	buildLportFlowDispForVpnToScf(BigInteger dpId, int lportTag, long scfTag, short gotoTableId) Creates the flow that sends the packet from the VPN to the SCF pipeline.
static List<org.opendaylight.genius.mdsalutil.MatchInfo>	buildMatchOnLportTagAndSI(Integer lportTag, short serviceIndex) Builds the Match for flows that must match on a given lportTag and serviceIndex.
static List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction>	buildSetVrfTagAndGotoFibInstructions(Integer vpnTag) Builds a The Instructions that sets the VpnTag in metadata and sends to FIB table.
static String	buildVpnPseudoPortIfName(Long dpId, long scfTag, int scsTag, int lportTag) Get fake VPNPseudoPort interface name.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VrfTables>	buildVrfId(String rd)
static List<String>	getAllVpnIfaceNames(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker, String vpnName)
static List<VpnToPseudoPortData>	getAllVpnToPseudoPortData(org.opendaylight.controller.md.sal.binding.api.DataBroker broker)
static List<VrfEntry>	getAllVrfEntries(org.opendaylight.controller.md.sal.binding.api.DataBroker broker, String rd) Returns all the VrfEntries that belong to a given VPN.
static BigInteger	getCookieL3(int vpnId)
static String	getL3VpnToScfLportDispatcherFlowRef(Integer lportTag) Id for the Flow that is inserted in LPortDispatcher table that is in charge of delivering packets from the L3VPN to the SCF Pipeline.
static BigInteger	getMetadataSCF(long scfTag)
static String	getScfToL3VpnLportDispatcherFlowRef(Integer lportTag) Builds an identifier for the flow that is inserted in LPortDispatcher table and that is in charge of handling packets that are delivered from the SCF to the L3VPN Pipeline.
static long	getVpnId(org.opendaylight.controller.md.sal.binding.api.DataBroker broker, String vpnName) Retrieves the VpnId (datapath id) searching by VpnInstanceName.
static com.google.common.base.Optional<VpnInstanceOpDataEntry>	getVpnInstanceOpData(org.opendaylight.controller.md.sal.binding.api.DataBroker broker, String rd) Retrieves from MDSAL the Operational Data of the VPN specified by its Route-Distinguisher.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VpnInstanceOpDataEntry>	getVpnInstanceOpDataIdentifier(String rd)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VpnInstance>	getVpnInstanceToVpnIdIdentifier(String vpnName)
static com.google.common.base.Optional<Long>	getVpnPseudoLportTag(org.opendaylight.controller.md.sal.binding.api.DataBroker broker, String rd)
static com.google.common.base.Optional<VpnToPseudoPortData>	getVpnPseudoPortData(org.opendaylight.controller.md.sal.binding.api.DataBroker broker, String rd)
static String	getVpnRd(org.opendaylight.controller.md.sal.binding.api.DataBroker broker, String vpnName) Retrieves the VPN's Route Distinguisher out from the VpnName.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VpnToDpnList>	getVpnToDpnListIdentifier(String rd, BigInteger dpnId)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VpnToPseudoPortData>	getVpnToPseudoPortTagIid(String rd)
static void	programLFibEntriesForSCF(org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdsalMgr, BigInteger dpId, List<VrfEntry> vrfEntries, int lportTag, int addOrRemove) Modifies the LFIB table by adding/removing flows that redirects traffic from a VPN into the SCF via the VpnPseudoLport.
static void	programLPortDispatcherFlowForScfToVpn(org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdsalManager, long vpnId, BigInteger dpId, Integer vpnPseudoLportTag, int addOrRemove) Installs/removes a flow in LPortDispatcher table that is in charge of handling packets that falls back from SCF Pipeline to L3Vpn.
static void	programLPortDispatcherFlowForVpnToScf(org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdsalManager, BigInteger dpId, int lportTag, long scfTag, short gotoTableId, int addOrRemove) Installs/removes a flow in LPortDispatcher table that is in charge of sending the traffic to the SCF Pipeline.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VpnServiceChainUtils

public VpnServiceChainUtils()

Method Detail

getMetadataSCF

public static BigInteger getMetadataSCF(long scfTag)

getCookieL3

public static BigInteger getCookieL3(int vpnId)

getVpnInstanceOpDataIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VpnInstanceOpDataEntry> getVpnInstanceOpDataIdentifier(String rd)

buildBoundServicesIid

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices> buildBoundServicesIid(short servicePrio,
                                                                                                                                                                                                                                            String ifaceName)

getVpnInstanceOpData

public static com.google.common.base.Optional<VpnInstanceOpDataEntry> getVpnInstanceOpData(org.opendaylight.controller.md.sal.binding.api.DataBroker broker,
                                                                                           String rd)

Retrieves from MDSAL the Operational Data of the VPN specified by its Route-Distinguisher.

Parameters:

rd - Route-Distinguisher of the VPN

Returns:

the Operational Data of the VPN or absent if no VPN could be found for the given RD or if the VPN does not have operational data.

buildVrfId

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VrfTables> buildVrfId(String rd)

getVpnToDpnListIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VpnToDpnList> getVpnToDpnListIdentifier(String rd,
                                                                                                                 BigInteger dpnId)

getVpnInstanceToVpnIdIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VpnInstance> getVpnInstanceToVpnIdIdentifier(String vpnName)

getVpnToPseudoPortTagIid

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VpnToPseudoPortData> getVpnToPseudoPortTagIid(String rd)

getVpnPseudoPortData

public static com.google.common.base.Optional<VpnToPseudoPortData> getVpnPseudoPortData(org.opendaylight.controller.md.sal.binding.api.DataBroker broker,
                                                                                        String rd)

getAllVpnToPseudoPortData

public static List<VpnToPseudoPortData> getAllVpnToPseudoPortData(org.opendaylight.controller.md.sal.binding.api.DataBroker broker)

buildVpnPseudoPortIfName

public static String buildVpnPseudoPortIfName(Long dpId,
                                              long scfTag,
                                              int scsTag,
                                              int lportTag)

Get fake VPNPseudoPort interface name.

Parameters:

dpId - Dpn Id

scfTag - Service Function tag

scsTag - Service Chain tag

lportTag - Lport tag

Returns:

the fake VpnPseudoPort interface name

getVpnId

public static long getVpnId(org.opendaylight.controller.md.sal.binding.api.DataBroker broker,
                            String vpnName)

Retrieves the VpnId (datapath id) searching by VpnInstanceName.

Parameters:

broker - Reference to the MDSAL Databroker service

vpnName - The Vpn instance name

Returns:

the datapath identifier for the specified VPN

getVpnRd

public static String getVpnRd(org.opendaylight.controller.md.sal.binding.api.DataBroker broker,
                              String vpnName)

Retrieves the VPN's Route Distinguisher out from the VpnName.

Parameters:

broker - Reference to the MDSAL Databroker service

vpnName - The Vpn Instance Name. Typically the UUID.

Returns:

the RouteDistinguiser for the specified VPN

getAllVrfEntries

public static List<VrfEntry> getAllVrfEntries(org.opendaylight.controller.md.sal.binding.api.DataBroker broker,
                                              String rd)

Returns all the VrfEntries that belong to a given VPN.

Parameters:

broker - Reference to the MDSAL Databroker service

rd - Route-distinguisher of the VPN

Returns:

the list of the matching VrfEntries

programLPortDispatcherFlowForScfToVpn

public static void programLPortDispatcherFlowForScfToVpn(org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdsalManager,
                                                         long vpnId,
                                                         BigInteger dpId,
                                                         Integer vpnPseudoLportTag,
                                                         int addOrRemove)

Installs/removes a flow in LPortDispatcher table that is in charge of handling packets that falls back from SCF Pipeline to L3Vpn.

Parameters:

mdsalManager - MDSAL Util API accessor

vpnId - Dataplane identifier of the VPN, the Vrf Tag.

dpId - The DPN where the flow must be installed/removed

vpnPseudoLportTag - Dataplane identifier for the VpnPseudoPort

addOrRemove - States if the flow must be created or removed

buildLPortDispFromScfToL3VpnFlow

public static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow buildLPortDispFromScfToL3VpnFlow(Long vpnId,
                                                                                                                                        BigInteger dpId,
                                                                                                                                        Integer lportTag,
                                                                                                                                        int addOrRemove)

Build the flow that must be inserted when there is a ScHop whose egressPort is a VPN Pseudo Port. In that case, packets must be moved from the SCF to VPN Pipeline.

Flow matches: VpnPseudo port lPortTag + SI=L3VPN Actions: Write vrfTag in Metadata + goto FIB Table

Parameters:

vpnId - Dataplane identifier of the VPN, the Vrf Tag.

dpId - The DPN where the flow must be installed/removed

lportTag - Dataplane identifier for the VpnPseudoPort

addOrRemove - States if it must build a Flow to be created or removed

Returns:

the Flow object

buildMatchOnLportTagAndSI

public static List<org.opendaylight.genius.mdsalutil.MatchInfo> buildMatchOnLportTagAndSI(Integer lportTag,
                                                                                          short serviceIndex)

Builds the Match for flows that must match on a given lportTag and serviceIndex.

Returns:

the Match as a list.

buildSetVrfTagAndGotoFibInstructions

public static List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction> buildSetVrfTagAndGotoFibInstructions(Integer vpnTag)

Builds a The Instructions that sets the VpnTag in metadata and sends to FIB table.

Parameters:

vpnTag - Dataplane identifier of the VPN.

Returns:

the list of Instructions

buildLFibVpnPseudoPortFlow

public static org.opendaylight.genius.mdsalutil.FlowEntity buildLFibVpnPseudoPortFlow(BigInteger dpId,
                                                                                      Long label,
                                                                                      String nextHop,
                                                                                      int lportTag)

Builds a Flow for the LFIB table that sets the LPortTag of the VpnPseudoPort and sends to LPortDispatcher table.

• Matching: eth_type = MPLS, mpls_label = VPN MPLS label
• Actions: setMetadata LportTag and SI=2, pop MPLS, Go to LPortDispacherTable

Parameters:

dpId - DpnId

label - MPLS label

nextHop - Next Hop IP

lportTag - Pseudo Logical Port tag

Returns:

the FlowEntity

programLFibEntriesForSCF

public static void programLFibEntriesForSCF(org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdsalMgr,
                                            BigInteger dpId,
                                            List<VrfEntry> vrfEntries,
                                            int lportTag,
                                            int addOrRemove)

Modifies the LFIB table by adding/removing flows that redirects traffic from a VPN into the SCF via the VpnPseudoLport. Flows that match on the label and sets the VpnPseudoPort lportTag and sends to LPortDispatcher (via table 80)

programLPortDispatcherFlowForVpnToScf

public static void programLPortDispatcherFlowForVpnToScf(org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdsalManager,
                                                         BigInteger dpId,
                                                         int lportTag,
                                                         long scfTag,
                                                         short gotoTableId,
                                                         int addOrRemove)

Installs/removes a flow in LPortDispatcher table that is in charge of sending the traffic to the SCF Pipeline.

buildLportFlowDispForVpnToScf

public static org.opendaylight.genius.mdsalutil.FlowEntity buildLportFlowDispForVpnToScf(BigInteger dpId,
                                                                                         int lportTag,
                                                                                         long scfTag,
                                                                                         short gotoTableId)

Creates the flow that sends the packet from the VPN to the SCF pipeline. This usually happens when there is an ScHop whose ingressPort is a VpnPseudoPort.

• Matches: lportTag = vpnPseudoLPortTag, SI = 1
• Actions: setMetadata(scfTag), Go to: UpSubFilter table

getVpnPseudoLportTag

public static com.google.common.base.Optional<Long> getVpnPseudoLportTag(org.opendaylight.controller.md.sal.binding.api.DataBroker broker,
                                                                         String rd)

buildLPortDispFlowForVpntoVpn

public static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow buildLPortDispFlowForVpntoVpn(Integer dstLportTag,
                                                                                                                                     Integer vpnTag)

Creates a Flow that does the trick of moving the packets from one VPN to another VPN.

getL3VpnToScfLportDispatcherFlowRef

public static String getL3VpnToScfLportDispatcherFlowRef(Integer lportTag)

Id for the Flow that is inserted in LPortDispatcher table that is in charge of delivering packets from the L3VPN to the SCF Pipeline. The VpnPseudoLPort tag and the SCF_SERVICE_INDEX is enough to identify this kind of flows.

getScfToL3VpnLportDispatcherFlowRef

public static String getScfToL3VpnLportDispatcherFlowRef(Integer lportTag)

Builds an identifier for the flow that is inserted in LPortDispatcher table and that is in charge of handling packets that are delivered from the SCF to the L3VPN Pipeline.

getAllVpnIfaceNames

public static List<String> getAllVpnIfaceNames(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker,
                                               String vpnName)