org.onosproject.driver.pipeline

Class Ofdpa2GroupHandler

java.lang.Object

org.onosproject.driver.pipeline.Ofdpa2GroupHandler

Direct Known Subclasses:

CpqdOfdpa2GroupHandler, Ofdpa3GroupHandler

public class Ofdpa2GroupHandler
extends Object

Group handler for OFDPA2 pipeline.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Ofdpa2GroupHandler.GroupChainElem Represents a group element that is part of a chain of groups.
protected class	Ofdpa2GroupHandler.GroupInfo Utility class for moving group information around.
protected static class	Ofdpa2GroupHandler.OfdpaMplsGroupSubType Helper enum to handle the different MPLS group types.
protected class	Ofdpa2GroupHandler.OfdpaNextGroup Represents an entire group-chain that implements a Next-Objective from the application.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.onosproject.net.DeviceId	deviceId
protected org.onosproject.net.group.GroupService	groupService
protected static int	L2_FLOOD_TYPE
protected static int	L2_INTERFACE_TYPE
protected static int	L3_ECMP_TYPE
protected static int	L3_INTERFACE_TYPE
protected static int	L3_MULTICAST_TYPE
protected static int	L3_UNICAST_TYPE
protected static int	MPLS_INTERFACE_TYPE
protected static int	MPLS_L3VPN_SUBTYPE
protected ConcurrentHashMap<Integer,org.onosproject.net.flowobjective.NextObjective>	pendingBuckets
protected static long	PORT_HIGHER_BITS_MASK
protected static int	PORT_LOWER_BITS_MASK
protected org.onosproject.store.service.StorageService	storageService
protected static int	SUBTYPE_MASK
protected static int	TYPE_MASK
protected static int	TYPE_VLAN_MASK

Constructor Summary

Constructors

Constructor and Description
Ofdpa2GroupHandler()

Method Summary

Modifier and Type	Method and Description
protected void	addBucketToGroup(org.onosproject.net.flowobjective.NextObjective nextObjective, org.onosproject.net.behaviour.NextGroup next) Adds a bucket to the top level group of a group-chain, and creates the chain.
protected void	addGroup(org.onosproject.net.flowobjective.NextObjective nextObjective)
protected void	createHashBucketChains(org.onosproject.net.flowobjective.NextObjective nextObj, List<Deque<org.onosproject.net.group.GroupKey>> allGroupKeys, List<Ofdpa2GroupHandler.GroupInfo> unsentGroups) Creates group chains for all buckets in a hashed group, and stores the GroupInfos and GroupKeys for all the groups in the lists passed in, which should be empty.
protected Ofdpa2GroupHandler.GroupInfo	createL2L3Chain(org.onosproject.net.flow.TrafficTreatment treatment, int nextId, org.onosproject.core.ApplicationId appId, boolean mpls, org.onosproject.net.flow.TrafficSelector meta) Creates one of two possible group-chains from the treatment passed in.
protected Ofdpa2GroupHandler.GroupInfo	createL2L3ChainInternal(org.onosproject.net.flow.TrafficTreatment treatment, int nextId, org.onosproject.core.ApplicationId appId, boolean mpls, org.onosproject.net.flow.TrafficSelector meta, boolean useSetVlanExtension) Internal implementation of createL2L3Chain.
protected int	getNextAvailableIndex()
protected void	init(org.onosproject.net.DeviceId deviceId, org.onosproject.net.behaviour.PipelinerContext context)
protected int	l2InterfaceGroupKey(org.onosproject.net.DeviceId deviceId, org.onlab.packet.VlanId vlanId, long portNumber) Returns a hash as the L2 Interface Group Key.
Integer	makeMplsForwardingGroupId(Ofdpa2GroupHandler.OfdpaMplsGroupSubType subType, int index) Creates MPLS Forwarding group id given a sub type and the index.
Integer	makeMplsLabelGroupId(Ofdpa2GroupHandler.OfdpaMplsGroupSubType subType, int index) Creates MPLS Label group id given a sub type and the index.
protected void	processHashedNextObjective(org.onosproject.net.flowobjective.NextObjective nextObj) As per the OFDPA 2.0 TTP, packets are sent out of ports by using a chain of groups.
protected void	processPwNextObjective(org.onosproject.net.flowobjective.NextObjective nextObjective) Processes the pseudo wire related next objective.
protected static org.onosproject.net.PortNumber	readOutPortFromTreatment(org.onosproject.net.flow.TrafficTreatment tt) Returns the outport in a traffic treatment.
protected void	removeBucketFromGroup(org.onosproject.net.flowobjective.NextObjective nextObjective, org.onosproject.net.behaviour.NextGroup next) Removes the bucket in the top level group of a possible group-chain.
protected void	removeGroup(org.onosproject.net.flowobjective.NextObjective nextObjective, org.onosproject.net.behaviour.NextGroup next) Removes all groups in multiple possible group-chains that represent the next objective.
protected void	updatePendingGroups(org.onosproject.net.group.GroupKey gkey, Ofdpa2GroupHandler.GroupChainElem gce)
protected void	updatePendingNextObjective(org.onosproject.net.group.GroupKey key, Ofdpa2GroupHandler.OfdpaNextGroup value)
boolean	verifyHashedNextObjective(org.onosproject.net.flowobjective.NextObjective nextObjective) The purpose of this function is to verify if the hashed next objective is supported by the current pipeline.

Methods inherited from class java.lang.Object

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

Field Detail

L2_INTERFACE_TYPE

protected static final int L2_INTERFACE_TYPE

See Also:

Constant Field Values

L3_INTERFACE_TYPE

protected static final int L3_INTERFACE_TYPE

See Also:

Constant Field Values

L3_UNICAST_TYPE

protected static final int L3_UNICAST_TYPE

See Also:

Constant Field Values

L3_MULTICAST_TYPE

protected static final int L3_MULTICAST_TYPE

See Also:

Constant Field Values

MPLS_INTERFACE_TYPE

protected static final int MPLS_INTERFACE_TYPE

See Also:

Constant Field Values

MPLS_L3VPN_SUBTYPE

protected static final int MPLS_L3VPN_SUBTYPE

See Also:

Constant Field Values

L3_ECMP_TYPE

protected static final int L3_ECMP_TYPE

See Also:

Constant Field Values

L2_FLOOD_TYPE

protected static final int L2_FLOOD_TYPE

See Also:

Constant Field Values

TYPE_MASK

protected static final int TYPE_MASK

See Also:

Constant Field Values

SUBTYPE_MASK

protected static final int SUBTYPE_MASK

See Also:

Constant Field Values

TYPE_VLAN_MASK

protected static final int TYPE_VLAN_MASK

See Also:

Constant Field Values

PORT_LOWER_BITS_MASK

protected static final int PORT_LOWER_BITS_MASK

See Also:

Constant Field Values

PORT_HIGHER_BITS_MASK

protected static final long PORT_HIGHER_BITS_MASK

See Also:

Constant Field Values

groupService

protected org.onosproject.net.group.GroupService groupService

storageService

protected org.onosproject.store.service.StorageService storageService

deviceId

protected org.onosproject.net.DeviceId deviceId

pendingBuckets

protected ConcurrentHashMap<Integer,org.onosproject.net.flowobjective.NextObjective> pendingBuckets

Constructor Detail

Ofdpa2GroupHandler

public Ofdpa2GroupHandler()

Method Detail

init

protected void init(org.onosproject.net.DeviceId deviceId,
                    org.onosproject.net.behaviour.PipelinerContext context)

verifyHashedNextObjective

public boolean verifyHashedNextObjective(org.onosproject.net.flowobjective.NextObjective nextObjective)

The purpose of this function is to verify if the hashed next objective is supported by the current pipeline.

Parameters:

nextObjective - the hashed objective to verify

Returns:

true if the hashed objective is supported. Otherwise false.

addGroup

protected void addGroup(org.onosproject.net.flowobjective.NextObjective nextObjective)

createL2L3Chain

protected Ofdpa2GroupHandler.GroupInfo createL2L3Chain(org.onosproject.net.flow.TrafficTreatment treatment,
                                                       int nextId,
                                                       org.onosproject.core.ApplicationId appId,
                                                       boolean mpls,
                                                       org.onosproject.net.flow.TrafficSelector meta)

Creates one of two possible group-chains from the treatment passed in. Depending on the MPLS boolean, this method either creates an L3Unicast Group --> L2Interface Group, if mpls is false; or MPLSInterface Group --> L2Interface Group, if mpls is true; The returned 'inner' group description is always the L2 Interface group.

Parameters:

treatment - that needs to be broken up to create the group chain

nextId - of the next objective that needs this group chain

appId - of the application that sent this next objective

mpls - determines if L3Unicast or MPLSInterface group is created

meta - metadata passed in by the application as part of the nextObjective

Returns:

GroupInfo containing the GroupDescription of the L2Interface group(inner) and the GroupDescription of the (outer) L3Unicast/MPLSInterface group. May return null if there is an error in processing the chain

createL2L3ChainInternal

protected Ofdpa2GroupHandler.GroupInfo createL2L3ChainInternal(org.onosproject.net.flow.TrafficTreatment treatment,
                                                               int nextId,
                                                               org.onosproject.core.ApplicationId appId,
                                                               boolean mpls,
                                                               org.onosproject.net.flow.TrafficSelector meta,
                                                               boolean useSetVlanExtension)

Internal implementation of createL2L3Chain.

The is_present bit in set_vlan_vid action is required to be 0 in OFDPA i12. Since it is non-OF spec, we need an extension treatment for that. The useSetVlanExtension must be set to false for OFDPA i12.

Parameters:

treatment - that needs to be broken up to create the group chain

nextId - of the next objective that needs this group chain

appId - of the application that sent this next objective

mpls - determines if L3Unicast or MPLSInterface group is created

meta - metadata passed in by the application as part of the nextObjective

useSetVlanExtension - use the setVlanVid extension that has is_present bit set to 0.

Returns:

GroupInfo containing the GroupDescription of the L2Interface group(inner) and the GroupDescription of the (outer) L3Unicast/MPLSInterface group. May return null if there is an error in processing the chain

processHashedNextObjective

protected void processHashedNextObjective(org.onosproject.net.flowobjective.NextObjective nextObj)

As per the OFDPA 2.0 TTP, packets are sent out of ports by using a chain of groups. The hashed Next Objective passed in by the application has to be broken up into a group chain comprising of an L3 ECMP group as the top level group. Buckets of this group can point to a variety of groups in a group chain, depending on the whether MPLS labels are being pushed or not.

NOTE: We do not create MPLS ECMP groups as they are unimplemented in OF-DPA 2.0 (even though it is in the spec). Therefore we do not check the nextObjective meta to see what is matching before being sent to this nextObjective.

Parameters:

nextObj - the nextObjective of type HASHED

createHashBucketChains

protected void createHashBucketChains(org.onosproject.net.flowobjective.NextObjective nextObj,
                                      List<Deque<org.onosproject.net.group.GroupKey>> allGroupKeys,
                                      List<Ofdpa2GroupHandler.GroupInfo> unsentGroups)

Creates group chains for all buckets in a hashed group, and stores the GroupInfos and GroupKeys for all the groups in the lists passed in, which should be empty.

Does not create the top level ECMP group. Does not actually send the groups to the groupService.

Parameters:

nextObj - the Next Objective with buckets that need to be converted to group chains

allGroupKeys - a list to store groupKey for each bucket-group-chain

unsentGroups - a list to store GroupInfo for each bucket-group-chain

processPwNextObjective

protected void processPwNextObjective(org.onosproject.net.flowobjective.NextObjective nextObjective)

Processes the pseudo wire related next objective. This procedure try to reuse the mpls label groups, the mpls interface group and the l2 interface group.

Parameters:

nextObjective - the objective to process.

addBucketToGroup

protected void addBucketToGroup(org.onosproject.net.flowobjective.NextObjective nextObjective,
                                org.onosproject.net.behaviour.NextGroup next)

Adds a bucket to the top level group of a group-chain, and creates the chain. Ensures that bucket being added is not a duplicate, by checking existing buckets for the same outport.

Parameters:

nextObjective - the bucket information for a next group

next - the representation of the existing group-chain for this next objective

removeBucketFromGroup

protected void removeBucketFromGroup(org.onosproject.net.flowobjective.NextObjective nextObjective,
                                     org.onosproject.net.behaviour.NextGroup next)

Removes the bucket in the top level group of a possible group-chain. Does not remove the groups in the group-chain pointed to by this bucket, as they may be in use (referenced by other groups) elsewhere.

Parameters:

nextObjective - the bucket information for a next group

next - the representation of the existing group-chain for this next objective

removeGroup

protected void removeGroup(org.onosproject.net.flowobjective.NextObjective nextObjective,
                           org.onosproject.net.behaviour.NextGroup next)

Removes all groups in multiple possible group-chains that represent the next objective.

Parameters:

nextObjective - the next objective to remove

next - the NextGroup that represents the existing group-chain for this next objective

updatePendingNextObjective

protected void updatePendingNextObjective(org.onosproject.net.group.GroupKey key,
                                          Ofdpa2GroupHandler.OfdpaNextGroup value)

updatePendingGroups

protected void updatePendingGroups(org.onosproject.net.group.GroupKey gkey,
                                   Ofdpa2GroupHandler.GroupChainElem gce)

getNextAvailableIndex

protected int getNextAvailableIndex()

readOutPortFromTreatment

protected static org.onosproject.net.PortNumber readOutPortFromTreatment(org.onosproject.net.flow.TrafficTreatment tt)

Returns the outport in a traffic treatment.

Parameters:

tt - the treatment

Returns:

the PortNumber for the outport or null

l2InterfaceGroupKey

protected int l2InterfaceGroupKey(org.onosproject.net.DeviceId deviceId,
                                  org.onlab.packet.VlanId vlanId,
                                  long portNumber)

Returns a hash as the L2 Interface Group Key. Keep the lower 6-bit for port since port number usually smaller than 64. Hash other information into remaining 28 bits.

Parameters:

deviceId - Device ID

vlanId - VLAN ID

portNumber - Port number

Returns:

L2 interface group key

makeMplsLabelGroupId

public Integer makeMplsLabelGroupId(Ofdpa2GroupHandler.OfdpaMplsGroupSubType subType,
                                    int index)

Creates MPLS Label group id given a sub type and the index.

Parameters:

subType - the MPLS Label group sub type

index - the index of the group

Returns:

the OFDPA group id

makeMplsForwardingGroupId

public Integer makeMplsForwardingGroupId(Ofdpa2GroupHandler.OfdpaMplsGroupSubType subType,
                                         int index)

Creates MPLS Forwarding group id given a sub type and the index.

Parameters:

subType - the MPLS forwarding group sub type

index - the index of the group

Returns:

the OFDPA group id