org.onosproject.driver.pipeline

Class Ofdpa2Pipeline

java.lang.Object

org.onosproject.net.driver.AbstractBehaviour

org.onosproject.net.driver.AbstractHandlerBehaviour

org.onosproject.driver.pipeline.Ofdpa2Pipeline

All Implemented Interfaces:

org.onosproject.net.behaviour.Pipeliner, org.onosproject.net.driver.Behaviour, org.onosproject.net.driver.HandlerBehaviour

Direct Known Subclasses:

CpqdOfdpa2Pipeline, Ofdpa3Pipeline

public class Ofdpa2Pipeline
extends org.onosproject.net.driver.AbstractHandlerBehaviour
implements org.onosproject.net.behaviour.Pipeliner

Driver for Broadcom's OF-DPA v2.0 TTP.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Ofdpa2Pipeline.RetryFlows Utility class that retries sending flows a fixed number of times, even if some of the attempts are successful.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	ACL_TABLE
protected static org.onlab.util.KryoNamespace	appKryo
protected static int	BRIDGING_TABLE
protected org.onosproject.core.CoreService	coreService
protected static int	DEFAULT_PRIORITY
protected org.onosproject.net.DeviceId	deviceId
protected org.onosproject.net.device.DeviceService	deviceService
protected org.onosproject.core.ApplicationId	driverId
protected ScheduledExecutorService	executorService
protected org.onosproject.net.flowobjective.FlowObjectiveStore	flowObjectiveStore
protected org.onosproject.net.flow.FlowRuleService	flowRuleService
protected Ofdpa2GroupHandler	groupHandler
protected org.onosproject.net.group.GroupService	groupService
protected static int	HIGHEST_PRIORITY
protected static int	LOWEST_PRIORITY
protected static int	MAC_LEARNING_TABLE
protected static int	MAX_RETRY_ATTEMPTS
protected static int	MPLS_L3_TYPE
protected static int	MPLS_TABLE_0
protected static int	MPLS_TABLE_1
protected static int	MULTICAST_ROUTING_TABLE
protected static long	OFPP_MAX
protected static int	PORT_TABLE
protected static int	RETRY_MS
protected Set<org.onosproject.net.flow.criteria.IPCriterion>	sentIpFilters
protected org.onlab.osgi.ServiceDirectory	serviceDirectory
protected static int	TMAC_TABLE
protected static int	UNICAST_ROUTING_TABLE
protected static int	VLAN_TABLE

Constructor Summary

Constructors

Constructor and Description
Ofdpa2Pipeline()

Method Summary

Modifier and Type	Method and Description
protected static void	fail(org.onosproject.net.flowobjective.Objective obj, org.onosproject.net.flowobjective.ObjectiveError error)
void	filter(org.onosproject.net.flowobjective.FilteringObjective filteringObjective)
void	forward(org.onosproject.net.flowobjective.ForwardingObjective fwd)
protected org.onosproject.net.behaviour.NextGroup	getGroupForNextObjective(Integer nextId)
List<String>	getNextMappings(org.onosproject.net.behaviour.NextGroup nextGroup)
void	init(org.onosproject.net.DeviceId deviceId, org.onosproject.net.behaviour.PipelinerContext context)
protected void	initializePipeline()
void	next(org.onosproject.net.flowobjective.NextObjective nextObjective)
protected static void	pass(org.onosproject.net.flowobjective.Objective obj)
protected List<org.onosproject.net.flow.FlowRule>	processEthDstFilter(org.onosproject.net.flow.criteria.PortCriterion portCriterion, org.onosproject.net.flow.criteria.EthCriterion ethCriterion, org.onosproject.net.flow.criteria.VlanIdCriterion vidCriterion, org.onlab.packet.VlanId assignedVlan, org.onosproject.core.ApplicationId applicationId) Allows routed packets with correct destination MAC to be directed to unicast-IP routing table or MPLS forwarding table.
protected List<org.onosproject.net.flow.FlowRule>	processEthDstOnlyFilter(org.onosproject.net.flow.criteria.EthCriterion ethCriterion, org.onosproject.core.ApplicationId applicationId)
protected Collection<org.onosproject.net.flow.FlowRule>	processEthDstSpecific(org.onosproject.net.flowobjective.ForwardingObjective fwd) Handles forwarding rules to the L2 bridging table.
protected Collection<org.onosproject.net.flow.FlowRule>	processEthTypeSpecific(org.onosproject.net.flowobjective.ForwardingObjective fwd) Handles forwarding rules to the IP and MPLS tables.
protected Collection<org.onosproject.net.flow.FlowRule>	processEthTypeSpecificInternal(org.onosproject.net.flowobjective.ForwardingObjective fwd, boolean allowDefaultRoute, int mplsNextTable) Internal implementation of processEthTypeSpecific.
protected void	processFilter(org.onosproject.net.flowobjective.FilteringObjective filt, boolean install, org.onosproject.core.ApplicationId applicationId) As per OFDPA 2.0 TTP, filtering of VLAN ids, MAC addresses (for routing) and IP addresses configured on switch ports happen in different tables.
protected List<org.onosproject.net.flow.FlowRule>	processMcastEthDstFilter(org.onosproject.net.flow.criteria.EthCriterion ethCriterion, org.onosproject.core.ApplicationId applicationId)
protected Collection<org.onosproject.net.flow.FlowRule>	processSpecific(org.onosproject.net.flowobjective.ForwardingObjective fwd) In the OF-DPA 2.0 pipeline, specific forwarding refers to the IP table (unicast or multicast) or the L2 table (mac + vlan) or the MPLS table.
protected Collection<org.onosproject.net.flow.FlowRule>	processVersatile(org.onosproject.net.flowobjective.ForwardingObjective fwd) In the OF-DPA 2.0 pipeline, versatile forwarding objectives go to the ACL table.
protected List<org.onosproject.net.flow.FlowRule>	processVlanIdFilter(org.onosproject.net.flow.criteria.PortCriterion portCriterion, org.onosproject.net.flow.criteria.VlanIdCriterion vidCriterion, org.onlab.packet.VlanId assignedVlan, org.onosproject.core.ApplicationId applicationId) Allows untagged packets into pipeline by assigning a vlan id.
protected List<org.onosproject.net.flow.FlowRule>	processVlanIdFilterInternal(org.onosproject.net.flow.criteria.PortCriterion portCriterion, org.onosproject.net.flow.criteria.VlanIdCriterion vidCriterion, org.onlab.packet.VlanId assignedVlan, org.onosproject.core.ApplicationId applicationId, boolean useSetVlanExtension) Internal implementation of processVlanIdFilter.
protected static org.onlab.packet.IpPrefix	readIpDstFromSelector(org.onosproject.net.flow.TrafficSelector selector)
protected static org.onlab.packet.VlanId	readVlanFromSelector(org.onosproject.net.flow.TrafficSelector selector)
protected void	sendForward(org.onosproject.net.flowobjective.ForwardingObjective fwd, Collection<org.onosproject.net.flow.FlowRule> rules)

Methods inherited from class org.onosproject.net.driver.AbstractHandlerBehaviour

handler, setHandler

Methods inherited from class org.onosproject.net.driver.AbstractBehaviour

data, setData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.net.driver.HandlerBehaviour

handler, setHandler

Methods inherited from interface org.onosproject.net.driver.Behaviour

data, setData

Field Detail

PORT_TABLE

protected static final int PORT_TABLE

See Also:

Constant Field Values

VLAN_TABLE

protected static final int VLAN_TABLE

See Also:

Constant Field Values

TMAC_TABLE

protected static final int TMAC_TABLE

See Also:

Constant Field Values

UNICAST_ROUTING_TABLE

protected static final int UNICAST_ROUTING_TABLE

See Also:

Constant Field Values

MULTICAST_ROUTING_TABLE

protected static final int MULTICAST_ROUTING_TABLE

See Also:

Constant Field Values

MPLS_TABLE_0

protected static final int MPLS_TABLE_0

See Also:

Constant Field Values

MPLS_TABLE_1

protected static final int MPLS_TABLE_1

See Also:

Constant Field Values

MPLS_L3_TYPE

protected static final int MPLS_L3_TYPE

See Also:

Constant Field Values

BRIDGING_TABLE

protected static final int BRIDGING_TABLE

See Also:

Constant Field Values

ACL_TABLE

protected static final int ACL_TABLE

See Also:

Constant Field Values

MAC_LEARNING_TABLE

protected static final int MAC_LEARNING_TABLE

See Also:

Constant Field Values

OFPP_MAX

protected static final long OFPP_MAX

See Also:

Constant Field Values

HIGHEST_PRIORITY

protected static final int HIGHEST_PRIORITY

See Also:

Constant Field Values

DEFAULT_PRIORITY

protected static final int DEFAULT_PRIORITY

See Also:

Constant Field Values

LOWEST_PRIORITY

protected static final int LOWEST_PRIORITY

See Also:

Constant Field Values

serviceDirectory

protected org.onlab.osgi.ServiceDirectory serviceDirectory

flowRuleService

protected org.onosproject.net.flow.FlowRuleService flowRuleService

coreService

protected org.onosproject.core.CoreService coreService

groupService

protected org.onosproject.net.group.GroupService groupService

flowObjectiveStore

protected org.onosproject.net.flowobjective.FlowObjectiveStore flowObjectiveStore

deviceId

protected org.onosproject.net.DeviceId deviceId

driverId

protected org.onosproject.core.ApplicationId driverId

deviceService

protected org.onosproject.net.device.DeviceService deviceService

appKryo

protected static org.onlab.util.KryoNamespace appKryo

groupHandler

protected Ofdpa2GroupHandler groupHandler

sentIpFilters

protected Set<org.onosproject.net.flow.criteria.IPCriterion> sentIpFilters

executorService

protected ScheduledExecutorService executorService

MAX_RETRY_ATTEMPTS

protected static final int MAX_RETRY_ATTEMPTS

See Also:

Constant Field Values

RETRY_MS

protected static final int RETRY_MS

See Also:

Constant Field Values

Constructor Detail

Ofdpa2Pipeline

public Ofdpa2Pipeline()

Method Detail

init

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

Specified by:

init in interface org.onosproject.net.behaviour.Pipeliner

initializePipeline

protected void initializePipeline()

filter

public void filter(org.onosproject.net.flowobjective.FilteringObjective filteringObjective)

Specified by:

filter in interface org.onosproject.net.behaviour.Pipeliner

forward

public void forward(org.onosproject.net.flowobjective.ForwardingObjective fwd)

Specified by:

forward in interface org.onosproject.net.behaviour.Pipeliner

sendForward

protected void sendForward(org.onosproject.net.flowobjective.ForwardingObjective fwd,
                           Collection<org.onosproject.net.flow.FlowRule> rules)

next

public void next(org.onosproject.net.flowobjective.NextObjective nextObjective)

Specified by:

next in interface org.onosproject.net.behaviour.Pipeliner

processFilter

protected void processFilter(org.onosproject.net.flowobjective.FilteringObjective filt,
                             boolean install,
                             org.onosproject.core.ApplicationId applicationId)

As per OFDPA 2.0 TTP, filtering of VLAN ids, MAC addresses (for routing) and IP addresses configured on switch ports happen in different tables. Note that IP filtering rules need to be added to the ACL table, as there is no mechanism to send to controller via IP table.

Parameters:

filt - the filtering objective

install - indicates whether to add or remove the objective

applicationId - the application that sent this objective

processVlanIdFilter

protected List<org.onosproject.net.flow.FlowRule> processVlanIdFilter(org.onosproject.net.flow.criteria.PortCriterion portCriterion,
                                                                      org.onosproject.net.flow.criteria.VlanIdCriterion vidCriterion,
                                                                      org.onlab.packet.VlanId assignedVlan,
                                                                      org.onosproject.core.ApplicationId applicationId)

Allows untagged packets into pipeline by assigning a vlan id. Vlan assignment is done by the application. Allows tagged packets into pipeline as per configured port-vlan info.

Parameters:

portCriterion - port on device for which this filter is programmed

vidCriterion - vlan assigned to port, or NONE for untagged

assignedVlan - assigned vlan-id for untagged packets

applicationId - for application programming this filter

Returns:

list of FlowRule for port-vlan filters

processVlanIdFilterInternal

protected List<org.onosproject.net.flow.FlowRule> processVlanIdFilterInternal(org.onosproject.net.flow.criteria.PortCriterion portCriterion,
                                                                              org.onosproject.net.flow.criteria.VlanIdCriterion vidCriterion,
                                                                              org.onlab.packet.VlanId assignedVlan,
                                                                              org.onosproject.core.ApplicationId applicationId,
                                                                              boolean useSetVlanExtension)

Internal implementation of processVlanIdFilter.

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:

portCriterion - port on device for which this filter is programmed

vidCriterion - vlan assigned to port, or NONE for untagged

assignedVlan - assigned vlan-id for untagged packets

applicationId - for application programming this filter

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

Returns:

list of FlowRule for port-vlan filters

processEthDstFilter

protected List<org.onosproject.net.flow.FlowRule> processEthDstFilter(org.onosproject.net.flow.criteria.PortCriterion portCriterion,
                                                                      org.onosproject.net.flow.criteria.EthCriterion ethCriterion,
                                                                      org.onosproject.net.flow.criteria.VlanIdCriterion vidCriterion,
                                                                      org.onlab.packet.VlanId assignedVlan,
                                                                      org.onosproject.core.ApplicationId applicationId)

Allows routed packets with correct destination MAC to be directed to unicast-IP routing table or MPLS forwarding table.

Parameters:

portCriterion - port on device for which this filter is programmed

ethCriterion - dstMac of device for which is filter is programmed

vidCriterion - vlan assigned to port, or NONE for untagged

assignedVlan - assigned vlan-id for untagged packets

applicationId - for application programming this filter

Returns:

list of FlowRule for port-vlan filters

processEthDstOnlyFilter

protected List<org.onosproject.net.flow.FlowRule> processEthDstOnlyFilter(org.onosproject.net.flow.criteria.EthCriterion ethCriterion,
                                                                          org.onosproject.core.ApplicationId applicationId)

processMcastEthDstFilter

protected List<org.onosproject.net.flow.FlowRule> processMcastEthDstFilter(org.onosproject.net.flow.criteria.EthCriterion ethCriterion,
                                                                           org.onosproject.core.ApplicationId applicationId)

processVersatile

protected Collection<org.onosproject.net.flow.FlowRule> processVersatile(org.onosproject.net.flowobjective.ForwardingObjective fwd)

In the OF-DPA 2.0 pipeline, versatile forwarding objectives go to the ACL table.

Parameters:

fwd - the forwarding objective of type 'versatile'

Returns:

a collection of flow rules to be sent to the switch. An empty collection may be returned if there is a problem in processing the flow rule

processSpecific

protected Collection<org.onosproject.net.flow.FlowRule> processSpecific(org.onosproject.net.flowobjective.ForwardingObjective fwd)

In the OF-DPA 2.0 pipeline, specific forwarding refers to the IP table (unicast or multicast) or the L2 table (mac + vlan) or the MPLS table.

Parameters:

fwd - the forwarding objective of type 'specific'

Returns:

a collection of flow rules. Typically there will be only one for this type of forwarding objective. An empty set may be returned if there is an issue in processing the objective.

processEthTypeSpecific

protected Collection<org.onosproject.net.flow.FlowRule> processEthTypeSpecific(org.onosproject.net.flowobjective.ForwardingObjective fwd)

Handles forwarding rules to the IP and MPLS tables.

Parameters:

fwd - the forwarding objective

Returns:

A collection of flow rules, or an empty set

processEthTypeSpecificInternal

protected Collection<org.onosproject.net.flow.FlowRule> processEthTypeSpecificInternal(org.onosproject.net.flowobjective.ForwardingObjective fwd,
                                                                                       boolean allowDefaultRoute,
                                                                                       int mplsNextTable)

Internal implementation of processEthTypeSpecific.

Wildcarded IPv4_DST is not supported in OFDPA i12. Therefore, we break the rule into 0.0.0.0/1 and 128.0.0.0/1. The allowDefaultRoute must be set to false for OFDPA i12.

Parameters:

fwd - the forwarding objective

allowDefaultRoute - allow wildcarded IPv4_DST or not

mplsNextTable - next MPLS table

Returns:

A collection of flow rules, or an empty set

processEthDstSpecific

protected Collection<org.onosproject.net.flow.FlowRule> processEthDstSpecific(org.onosproject.net.flowobjective.ForwardingObjective fwd)

Handles forwarding rules to the L2 bridging table. Flow actions are not allowed in the bridging table - instead we use L2 Interface group or L2 flood group

Parameters:

fwd - the forwarding objective

Returns:

A collection of flow rules, or an empty set

getGroupForNextObjective

protected org.onosproject.net.behaviour.NextGroup getGroupForNextObjective(Integer nextId)

pass

protected static void pass(org.onosproject.net.flowobjective.Objective obj)

fail

protected static void fail(org.onosproject.net.flowobjective.Objective obj,
                           org.onosproject.net.flowobjective.ObjectiveError error)

getNextMappings

public List<String> getNextMappings(org.onosproject.net.behaviour.NextGroup nextGroup)

Specified by:

getNextMappings in interface org.onosproject.net.behaviour.Pipeliner

readVlanFromSelector

protected static org.onlab.packet.VlanId readVlanFromSelector(org.onosproject.net.flow.TrafficSelector selector)

readIpDstFromSelector

protected static org.onlab.packet.IpPrefix readIpDstFromSelector(org.onosproject.net.flow.TrafficSelector selector)