org.opendaylight.netvirt.elan.arp.responder

Class ArpResponderUtil

java.lang.Object

org.opendaylight.netvirt.elan.arp.responder.ArpResponderUtil

public final class ArpResponderUtil
extends Object

Arp Responder Utility Class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ArpResponderUtil.TriFunction<T,U,S,R> A Interface that represent lambda TriFunction.

Method Summary

Modifier and Type	Method and Description
static org.opendaylight.genius.mdsalutil.FlowEntity	createArpDefaultFlow(BigInteger dpId, short tableId, int arpOpType, Supplier<List<org.opendaylight.genius.mdsalutil.MatchInfo>> matches, Supplier<List<org.opendaylight.genius.mdsalutil.ActionInfo>> actions)
static BigInteger	generateCookie(int lportTag, String ipAddress) Generate Cookie per flow.
static List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action>	getActions(org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager ifaceMgrRpcService, org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rpcs.rev160406.ItmRpcService itmRpcService, String ifName, String ipAddress, String macAddress, boolean isTunnelInterface) Get List of actions for ARP Responder Flows.
static org.opendaylight.genius.mdsalutil.FlowEntity	getArpResponderTableMissFlow(BigInteger dpnId) Get Default ARP Responder Drop flow on the DPN.
static List<org.opendaylight.genius.mdsalutil.BucketInfo>	getDefaultBucketInfos(short resubmitTableId, short resubmitTableId2) Get Bucket Actions for ARP Responder Group Flow.
static List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action>	getEgressActionsForInterface(org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager ifaceMgrRpcService, org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rpcs.rev160406.ItmRpcService itmRpcService, String ifName, int actionCounter, boolean isTunnelInterface) Get List of Egress Action for the VPN interface.
static List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction>	getExtInterfaceInstructions(org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager ifaceMgrRpcService, org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rpcs.rev160406.ItmRpcService itmRpcService, String extInterfaceName, String ipAddress, String macAddress) Get instruction list for ARP responder flows originated from ext-net e.g.
static String	getFlowId(int lportTag, String ipAdress) Creates Uniquely Identifiable flow Id.
static List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction>	getInterfaceInstructions(org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager ifaceMgrRpcService, String interfaceName, String ipAddress, String macAddress, org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rpcs.rev160406.ItmRpcService itmRpcService) Get instruction list for ARP responder flows.
static List<org.opendaylight.genius.mdsalutil.MatchInfo>	getMatchCriteria(int lportTag, ElanInstance elanInstance, String ipAddress) Get Match Criteria for the ARP Responder Flow.
static void	installFlow(org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdSalManager, BigInteger dpnId, String flowId, String flowName, int priority, BigInteger cookie, List<org.opendaylight.genius.mdsalutil.MatchInfo> matches, List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction> instructions) Install ARP Responder FLOW.
static void	installGroup(org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdSalManager, BigInteger dpnId, long groupdId, String groupName, List<org.opendaylight.genius.mdsalutil.BucketInfo> buckets) Install Group flow on the DPN.
static void	removeFlow(org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdSalManager, BigInteger dpnId, String flowId) Remove flow form DPN.
static Long	retrieveStandardArpResponderGroupId(org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService idManager) Uses the IdManager to retrieve ARP Responder GroupId from ELAN pool.

Methods inherited from class java.lang.Object

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

Method Detail

installGroup

public static void installGroup(org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdSalManager,
                                BigInteger dpnId,
                                long groupdId,
                                String groupName,
                                List<org.opendaylight.genius.mdsalutil.BucketInfo> buckets)

Install Group flow on the DPN.

Parameters:

mdSalManager - Reference of MDSAL API RPC that provides API for installing group flow

dpnId - DPN on which group flow to be installed

groupdId - Uniquely identifiable Group Id for the group flow

groupName - Name of the group flow

buckets - List of the bucket actions for the group flow

getArpResponderTableMissFlow

public static org.opendaylight.genius.mdsalutil.FlowEntity getArpResponderTableMissFlow(BigInteger dpnId)

Get Default ARP Responder Drop flow on the DPN.

Parameters:

dpnId - DPN on which group flow to be installed

getDefaultBucketInfos

public static List<org.opendaylight.genius.mdsalutil.BucketInfo> getDefaultBucketInfos(short resubmitTableId,
                                                                                       short resubmitTableId2)

Get Bucket Actions for ARP Responder Group Flow.

Install Default Groups, Group has 3 Buckets

• Punt to controller
• Resubmit to Table NwConstants.LPORT_DISPATCHER_TABLE, for ELAN flooding
• Resubmit to Table NwConstants.ARP_RESPONDER_TABLE, for ARP Auto response from DPN itself

Parameters:

resubmitTableId - Resubmit Flow Table Id

resubmitTableId2 - Resubmit Flow Table Id

Returns:

List of bucket actions

getMatchCriteria

public static List<org.opendaylight.genius.mdsalutil.MatchInfo> getMatchCriteria(int lportTag,
                                                                                 ElanInstance elanInstance,
                                                                                 String ipAddress)

Get Match Criteria for the ARP Responder Flow.

List of Match Criteria for ARP Responder

• Packet is ARP
• Packet is ARP Request
• The ARP packet is requesting for Gateway IP
• Metadata which is generated by using Service Index(NwConstants.L3VPN_SERVICE_INDEX) Lport Tag (MetaDataUtil.METADATA_MASK_LPORT_TAG) and VRF ID(MetaDataUtil.METADATA_MASK_VRFID)

Parameters:

lportTag - LPort Tag

elanInstance - Elan Instance

ipAddress - Ip Address to be matched to this flow

Returns:

List of Match criteria

getActions

public static List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action> getActions(org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager ifaceMgrRpcService,
                                                                                                                       org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rpcs.rev160406.ItmRpcService itmRpcService,
                                                                                                                       String ifName,
                                                                                                                       String ipAddress,
                                                                                                                       String macAddress,
                                                                                                                       boolean isTunnelInterface)

Get List of actions for ARP Responder Flows.

Actions consists of all the ARP actions and Resubmit Action to table NwConstants.ELAN_BASE_TABLE such that packets can flow ELAN Rule

Parameters:

ipAddress - IP Address for which ARP Response packet is to be generated

macAddress - MacAddress for which ARP Response packet is to be generated

Returns:

List of ARP Responder Actions actions

getInterfaceInstructions

public static List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction> getInterfaceInstructions(org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager ifaceMgrRpcService,
                                                                                                                                             String interfaceName,
                                                                                                                                             String ipAddress,
                                                                                                                                             String macAddress,
                                                                                                                                             org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rpcs.rev160406.ItmRpcService itmRpcService)

Get instruction list for ARP responder flows.

getExtInterfaceInstructions

public static List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction> getExtInterfaceInstructions(org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager ifaceMgrRpcService,
                                                                                                                                                org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rpcs.rev160406.ItmRpcService itmRpcService,
                                                                                                                                                String extInterfaceName,
                                                                                                                                                String ipAddress,
                                                                                                                                                String macAddress)

Get instruction list for ARP responder flows originated from ext-net e.g. router-gw/fip.
The split-horizon bit should be reset in order to allow traffic from provider network to be routed back to flat/VLAN network and override the egress table drop flow.
In order to allow write-metadata in the ARP responder table the resubmit action needs to be replaced with goto instruction.

installFlow

public static void installFlow(org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdSalManager,
                               BigInteger dpnId,
                               String flowId,
                               String flowName,
                               int priority,
                               BigInteger cookie,
                               List<org.opendaylight.genius.mdsalutil.MatchInfo> matches,
                               List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction> instructions)

Install ARP Responder FLOW.

Parameters:

mdSalManager - Reference of MDSAL API RPC that provides API for installing flow

dpnId - DPN on which flow to be installed

flowId - Uniquely Identifiable Arp Responder Table flow Id

flowName - Readable flow name

priority - Flow Priority

cookie - Flow Cookie

matches - List of Match Criteria for the flow

instructions - List of Instructions for the flow

removeFlow

public static void removeFlow(org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdSalManager,
                              BigInteger dpnId,
                              String flowId)

Remove flow form DPN.

Parameters:

mdSalManager - Reference of MDSAL API RPC that provides API for installing flow

dpnId - DPN form which flow to be removed

flowId - Uniquely Identifiable Arp Responder Table flow Id that is to be removed

getFlowId

public static String getFlowId(int lportTag,
                               String ipAdress)

Creates Uniquely Identifiable flow Id.

Parameters:

lportTag - LportTag of the flow

ipAdress - Gateway IP for which ARP Response flow to be installed

Returns:

Unique Flow Id

See Also:

ArpResponderConstant.FLOW_ID_FORMAT_WITH_LPORT, ArpResponderConstant.FLOW_ID_FORMAT_WITHOUT_LPORT

generateCookie

public static BigInteger generateCookie(int lportTag,
                                        String ipAddress)

Generate Cookie per flow.

Cookie is generated by Summation of NwConstants.COOKIE_ARP_RESPONDER + 1 + lportTag + Gateway IP

Parameters:

lportTag - Lport Tag of the flow

ipAddress - Gateway IP for which ARP Response flow to be installed

Returns:

Cookie

createArpDefaultFlow

public static org.opendaylight.genius.mdsalutil.FlowEntity createArpDefaultFlow(BigInteger dpId,
                                                                                short tableId,
                                                                                int arpOpType,
                                                                                Supplier<List<org.opendaylight.genius.mdsalutil.MatchInfo>> matches,
                                                                                Supplier<List<org.opendaylight.genius.mdsalutil.ActionInfo>> actions)

getEgressActionsForInterface

public static List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action> getEgressActionsForInterface(org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager ifaceMgrRpcService,
                                                                                                                                         org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rpcs.rev160406.ItmRpcService itmRpcService,
                                                                                                                                         String ifName,
                                                                                                                                         int actionCounter,
                                                                                                                                         boolean isTunnelInterface)

Get List of Egress Action for the VPN interface.

Parameters:

ifaceMgrRpcService - Interface Manager RPC reference that invokes API to retrieve Egress Action

ifName - VPN Interface for which Egress Action to be retrieved

actionCounter - Action Key

Returns:

List of Egress Actions

retrieveStandardArpResponderGroupId

public static Long retrieveStandardArpResponderGroupId(org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService idManager)

Uses the IdManager to retrieve ARP Responder GroupId from ELAN pool.

Parameters:

idManager - the id manager

Returns:

the integer