org.opendaylight.genius.mdsalutil

Class MetaDataUtil

java.lang.Object

org.opendaylight.genius.mdsalutil.MetaDataUtil

public final class MetaDataUtil
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static BigInteger	METADA_MASK_TUNNEL_ID
static BigInteger	METADA_MASK_VALID_TUNNEL_ID_BIT_AND_TUNNEL_ID
static int	METADATA_ELAN_TAG_BITLEN
static int	METADATA_ELAN_TAG_OFFSET
static BigInteger	METADATA_MASK_ACL_CONNTRACK_CLASSIFIER_TYPE
static BigInteger	METADATA_MASK_ACL_DROP
static BigInteger	METADATA_MASK_ELAN_SUBNET_ROUTE
static BigInteger	METADATA_MASK_LABEL_ITM
static BigInteger	METADATA_MASK_LPORT_TAG
static BigInteger	METADATA_MASK_LPORT_TAG_SH_FLAG
static BigInteger	METADATA_MASK_POLICY_CLASSIFER_ID
static BigInteger	METADATA_MASK_REMOTE_ACL_TAG
static BigInteger	METADATA_MASK_SERVICE
static BigInteger	METADATA_MASK_SERVICE_INDEX
static BigInteger	METADATA_MASK_SERVICE_SH_FLAG
static BigInteger	METADATA_MASK_SH_FLAG
static BigInteger	METADATA_MASK_SUBNET_ROUTE
static BigInteger	METADATA_MASK_VRFID
static int	METADATA_VPN_ID_BITLEN
static int	METADATA_VPN_ID_OFFSET

Method Summary

Modifier and Type	Method and Description
static BigInteger	getAclConntrackClassifierTypeFromMetaData(BigInteger conntrackClassifierType) Gets the ACL conntrack classifier type from meta data. Second bit in metadata is used for this purpose.
static BigInteger	getAclDropMetaData(BigInteger dropFlag)
static long	getElanMaskForReg()
static int	getElanTagFromMetadata(BigInteger metadata)
static BigInteger	getElanTagMetadata(long elanTag)
static BigInteger	getInterfaceTypeForReg6(int tunnelType)
static BigInteger	getLportFromMetadata(BigInteger metadata)
static BigInteger	getLportTagForReg6(int lportTag)
static long	getLportTagMaskForReg6()
static BigInteger	getLportTagMetaData(int lportTag)
static BigInteger	getMetaDataForLPortDispatcher(int lportTag, short serviceIndex)
static BigInteger	getMetaDataForLPortDispatcher(int lportTag, short serviceIndex, BigInteger serviceMetaData)
static BigInteger	getMetaDataForLPortDispatcher(int lportTag, short serviceIndex, BigInteger serviceMetaData, boolean isSHFlagSet)
static BigInteger	getMetadataLPort(int portTag)
static BigInteger	getMetaDataMaskForLPortDispatcher()
static BigInteger	getMetaDataMaskForLPortDispatcher(BigInteger metadataMaskForLPortTag)
static BigInteger	getMetaDataMaskForLPortDispatcher(BigInteger metadataMaskForServiceIndex, BigInteger metadataMaskForLPortTag, BigInteger metadataMaskForService)
static long	getNatRouterIdFromMetadata(BigInteger metadata)
static long	getPolicyClassifierFromMetadata(BigInteger metadata)
static BigInteger	getPolicyClassifierMetaData(long classifier)
static long	getReg6ValueForLPortDispatcher(int lportTag, short serviceIndex)
static long	getReg6ValueForLPortDispatcher(int lportTag, short serviceIndex, short interfaceType) Utility to fetch the register value for lport dispatcher table.
static BigInteger	getServiceIndexForReg6(int serviceIndex)
static BigInteger	getServiceIndexMetaData(int serviceIndex)
static int	getServiceTagFromMetadata(BigInteger metadata)
static BigInteger	getTunnelIdWithValidVniBitAndVniSet(int vni) For the tunnel id with VNI and valid-vni-flag set, the most significant byte should have 08.
static long	getVpnIdFromMetadata(BigInteger metadata)
static long	getVpnIdMaskForReg()
static BigInteger	getVpnIdMetadata(long vrfId)
static BigInteger	getWriteMetaDataMaskForDispatcherTable()
static BigInteger	getWriteMetaDataMaskForEgressDispatcherTable()
static BigInteger	mergeMetadataMask(BigInteger mask, BigInteger mask2)
static BigInteger	mergeMetadataValues(BigInteger metadata, BigInteger metadata2)

Methods inherited from class java.lang.Object

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

Field Detail

METADATA_MASK_LPORT_TAG

public static final BigInteger METADATA_MASK_LPORT_TAG

METADATA_MASK_SERVICE

public static final BigInteger METADATA_MASK_SERVICE

METADATA_MASK_SERVICE_INDEX

public static final BigInteger METADATA_MASK_SERVICE_INDEX

METADATA_MASK_VRFID

public static final BigInteger METADATA_MASK_VRFID

METADATA_MASK_REMOTE_ACL_TAG

public static final BigInteger METADATA_MASK_REMOTE_ACL_TAG

METADATA_MASK_POLICY_CLASSIFER_ID

public static final BigInteger METADATA_MASK_POLICY_CLASSIFER_ID

METADA_MASK_VALID_TUNNEL_ID_BIT_AND_TUNNEL_ID

public static final BigInteger METADA_MASK_VALID_TUNNEL_ID_BIT_AND_TUNNEL_ID

METADATA_MASK_LABEL_ITM

public static final BigInteger METADATA_MASK_LABEL_ITM

METADA_MASK_TUNNEL_ID

public static final BigInteger METADA_MASK_TUNNEL_ID

METADATA_MASK_SERVICE_SH_FLAG

public static final BigInteger METADATA_MASK_SERVICE_SH_FLAG

METADATA_MASK_LPORT_TAG_SH_FLAG

public static final BigInteger METADATA_MASK_LPORT_TAG_SH_FLAG

METADATA_MASK_SH_FLAG

public static final BigInteger METADATA_MASK_SH_FLAG

METADATA_MASK_ELAN_SUBNET_ROUTE

public static final BigInteger METADATA_MASK_ELAN_SUBNET_ROUTE

METADATA_MASK_SUBNET_ROUTE

public static final BigInteger METADATA_MASK_SUBNET_ROUTE

METADATA_MASK_ACL_CONNTRACK_CLASSIFIER_TYPE

public static final BigInteger METADATA_MASK_ACL_CONNTRACK_CLASSIFIER_TYPE

METADATA_MASK_ACL_DROP

public static final BigInteger METADATA_MASK_ACL_DROP

METADATA_ELAN_TAG_OFFSET

public static final int METADATA_ELAN_TAG_OFFSET

See Also:

Constant Field Values

METADATA_ELAN_TAG_BITLEN

public static final int METADATA_ELAN_TAG_BITLEN

See Also:

Constant Field Values

METADATA_VPN_ID_OFFSET

public static final int METADATA_VPN_ID_OFFSET

See Also:

Constant Field Values

METADATA_VPN_ID_BITLEN

public static final int METADATA_VPN_ID_BITLEN

See Also:

Constant Field Values

Method Detail

getMetaDataForLPortDispatcher

public static BigInteger getMetaDataForLPortDispatcher(int lportTag,
                                                       short serviceIndex)

getMetaDataForLPortDispatcher

public static BigInteger getMetaDataForLPortDispatcher(int lportTag,
                                                       short serviceIndex,
                                                       BigInteger serviceMetaData)

getMetaDataForLPortDispatcher

public static BigInteger getMetaDataForLPortDispatcher(int lportTag,
                                                       short serviceIndex,
                                                       BigInteger serviceMetaData,
                                                       boolean isSHFlagSet)

getPolicyClassifierMetaData

public static BigInteger getPolicyClassifierMetaData(long classifier)

getServiceIndexMetaData

public static BigInteger getServiceIndexMetaData(int serviceIndex)

getLportTagMetaData

public static BigInteger getLportTagMetaData(int lportTag)

getMetaDataMaskForLPortDispatcher

public static BigInteger getMetaDataMaskForLPortDispatcher()

getMetaDataMaskForLPortDispatcher

public static BigInteger getMetaDataMaskForLPortDispatcher(BigInteger metadataMaskForLPortTag)

getMetaDataMaskForLPortDispatcher

public static BigInteger getMetaDataMaskForLPortDispatcher(BigInteger metadataMaskForServiceIndex,
                                                           BigInteger metadataMaskForLPortTag,
                                                           BigInteger metadataMaskForService)

getMetadataLPort

public static BigInteger getMetadataLPort(int portTag)

getLportFromMetadata

public static BigInteger getLportFromMetadata(BigInteger metadata)

getElanTagFromMetadata

public static int getElanTagFromMetadata(BigInteger metadata)

getPolicyClassifierFromMetadata

public static long getPolicyClassifierFromMetadata(BigInteger metadata)

getElanTagMetadata

public static BigInteger getElanTagMetadata(long elanTag)

getServiceTagFromMetadata

public static int getServiceTagFromMetadata(BigInteger metadata)

getTunnelIdWithValidVniBitAndVniSet

public static BigInteger getTunnelIdWithValidVniBitAndVniSet(int vni)

For the tunnel id with VNI and valid-vni-flag set, the most significant byte should have 08. So, shifting 08 to 7 bytes (56 bits) and the result is OR-ed with VNI being shifted to 1 byte.

getNatRouterIdFromMetadata

public static long getNatRouterIdFromMetadata(BigInteger metadata)

getAclConntrackClassifierTypeFromMetaData

public static BigInteger getAclConntrackClassifierTypeFromMetaData(BigInteger conntrackClassifierType)

Gets the ACL conntrack classifier type from meta data.
Second bit in metadata is used for this purpose.

Conntrack supported traffic is identified by value 0 (0000 in binary) i.e., 0x0/0x2
Non-conntrack supported traffic is identified by value 2 (0010 in binary) i.e., 0x2/0x2

Parameters:

conntrackClassifierType - the conntrack classifier flag

Returns:

the acl conntrack classifier flag from meta data

getAclDropMetaData

public static BigInteger getAclDropMetaData(BigInteger dropFlag)

getVpnIdMetadata

public static BigInteger getVpnIdMetadata(long vrfId)

getVpnIdFromMetadata

public static long getVpnIdFromMetadata(BigInteger metadata)

getWriteMetaDataMaskForDispatcherTable

public static BigInteger getWriteMetaDataMaskForDispatcherTable()

getWriteMetaDataMaskForEgressDispatcherTable

public static BigInteger getWriteMetaDataMaskForEgressDispatcherTable()

getLportTagForReg6

public static BigInteger getLportTagForReg6(int lportTag)

getServiceIndexForReg6

public static BigInteger getServiceIndexForReg6(int serviceIndex)

getInterfaceTypeForReg6

public static BigInteger getInterfaceTypeForReg6(int tunnelType)

getReg6ValueForLPortDispatcher

public static long getReg6ValueForLPortDispatcher(int lportTag,
                                                  short serviceIndex)

getReg6ValueForLPortDispatcher

public static long getReg6ValueForLPortDispatcher(int lportTag,
                                                  short serviceIndex,
                                                  short interfaceType)

Utility to fetch the register value for lport dispatcher table. Register6 used for service binding will have first 4 bits of service-index, next 20 bits for lportTag, and next 4 bits for interface-type

getLportTagMaskForReg6

public static long getLportTagMaskForReg6()

getElanMaskForReg

public static long getElanMaskForReg()

getVpnIdMaskForReg

public static long getVpnIdMaskForReg()

mergeMetadataValues

public static BigInteger mergeMetadataValues(BigInteger metadata,
                                             BigInteger metadata2)

mergeMetadataMask

public static BigInteger mergeMetadataMask(BigInteger mask,
                                           BigInteger mask2)