org.opendaylight.sfc.ofrenderer.openflow

Interface SfcOfFlowProgrammerInterface

All Known Implementing Classes:

SfcOfFlowProgrammerImpl

public interface SfcOfFlowProgrammerInterface

An interface to be implemented by concrete classes that will write to OpenFlow or OVS switches.

Since:

2015-02-24

Author:

Brady Johnson (brady.allen.johnson@ericsson.com)

Method Summary

Modifier and Type	Method and Description
void	configureArpTransportIngressFlow(String sffNodeName, String mac)
void	configureClassifierTableDpdkInput(String sffNodeName, Long inPort)
void	configureClassifierTableDpdkOutput(String sffNodeName, Long outPort)
void	configureClassifierTableMatchAny(String sffNodeName)
void	configureGroup(String sffNodeName, String openflowNodeId, String sfgName, long sfgId, int groupType, List<GroupBucketInfo> bucketInfos, boolean isAddGroup)
void	configureGroupNextHopFlow(String sffNodeName, long sfpId, String srcMac, long groupId, String groupName)
void	configureIpv4TransportIngressFlow(String sffNodeName)
void	configureMacChainingNextHopFlow(String sffNodeName, String vmac, String dstSfMac, String nextVMac, boolean l2Tranparent)
void	configureMacChainingSfTransportEgressFlow(String sffNodeName, String dstMac, String port, String vmac)
void	configureMacChainingTransportIngressFlow(String sffNodeName)
void	configureMacNextHopFlow(String sffNodeName, long sfpId, String srcMac, String dstMac)
void	configureMplsLastHopTransportEgressFlow(String sffNodeName, String srcMac, String dstMac, long mplsLabel, String port, long pathId)
void	configureMplsPathMapperFlow(String sffNodeName, long label, long pathId, boolean isSf)
void	configureMplsTransportEgressFlow(String sffNodeName, String srcMac, String dstMac, long mplsLabel, String port, long pathId)
void	configureMplsTransportIngressFlow(String sffNodeName)
void	configureNextHopTableMatchAny(String sffNodeName)
void	configureNshEthLastHopTransportEgressFlow(String sffNodeName, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress sffIpAddress, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress sfMacAddress, long nshNsp, short nshNsi) Used by logical sff processor in order to write chain egress flows.
void	configureNshEthNextHopFlow(String sffNodeName, String srcMac, String dstMac, long nsp, short nsi) Configure nsh next hop flow.
void	configureNshEthTransportEgressFlow(String sffOpenFlowNodeName, long nshNsp, short nshNsi, List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action> actionList, String flowName) Configure transport egress flows, using a list of externally provided actions.
void	configureNshEthTransportEgressFlow(String sffNodeName, long nshNsp, short nshNsi, String port)
void	configureNshNscTransportEgressFlow(String sffNodeName, long nshNsp, short nshNsi, String switchPort)
void	configureNshVxgpeAppCoexistTransportEgressFlow(String sffNodeName, long nshNsp, short nshNsi, String sffIp)
void	configureNshVxgpeLastHopTransportEgressFlow(String sffNodeName, long nshNsp, short nshNsi, String port)
void	configureNshVxgpeNextHopFlow(String sffNodeName, String dstIp, String nshProxyIp, long nsp, short nsi)
void	configureNshVxgpeSfLoopbackEncapsulatedEgressFlow(String sffNodeName, String sfIp, short vxlanUdpPort, long sffPort)
void	configureNshVxgpeSfReturnLoopbackIngressFlow(String sffNodeName, short vxlanUdpPort, long sffPort)
void	configureNshVxgpeTransportEgressFlow(String sffNodeName, long nshNsp, short nshNsi, String port)
void	configureNshVxgpeTransportIngressFlow(String sffNodeName, long nshNsp, short nshNsi)
void	configurePathMapperAclTableMatchAny(String sffNodeName)
void	configurePathMapperTableMatchAny(String sffNodeName)
void	configureTransportEgressTableMatchAny(String sffNodeName)
void	configureTransportEgressTableMatchAnyResubmit(String sffNodeName, short nextTableId) Set the match any flow in the Transport Egress table to resubmit.
void	configureTransportIngressTableMatchAny(String sffNodeName)
void	configureTransportIngressTableMatchAnyResubmit(String sffNodeName, short nextTableId)
void	configureVlanLastHopTransportEgressFlow(String sffNodeName, String srcMac, String dstMac, int dstVlan, String port, long pathId)
void	configureVlanPathMapperFlow(String sffNodeName, int vlan, long pathId, boolean isSf)
void	configureVlanSfTransportEgressFlow(String sffNodeName, String srcMac, String dstMac, int dstVlan, String port, long pathId, boolean doPktin)
void	configureVlanTransportEgressFlow(String sffNodeName, String srcMac, String dstMac, int dstVlan, String port, long pathId)
void	configureVlanTransportIngressFlow(String sffNodeName)
Set<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId>	deleteRspFlows(long rspId) Deletes all flows created for a particular RSP and removes initialization flows from SFFs if the last RSP was removed.
void	flushFlows()
short	getMaxTableOffset()
short	getTableBase()
short	getTableEgress()
void	purgeFlows()
void	setFlowRspId(Long rspId)
void	setFlowWriter(SfcOfFlowWriterInterface sfcOfFlowWriter)
void	setTableBase(short tableBase)
void	setTableEgress(short tableEgress)
void	setTableIndexMapper(SfcTableIndexMapper tableIndexMapper) Setter for the table index mapper (class which provides the tables to use for Genius-based application coexistence).
void	shutdown()

Method Detail

shutdown

void shutdown()
       throws ExecutionException,
              InterruptedException

Throws:

ExecutionException

InterruptedException

getTableBase

short getTableBase()

setTableBase

void setTableBase(short tableBase)

getMaxTableOffset

short getMaxTableOffset()

getTableEgress

short getTableEgress()

setTableEgress

void setTableEgress(short tableEgress)

setFlowRspId

void setFlowRspId(Long rspId)

deleteRspFlows

Set<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId> deleteRspFlows(long rspId)

Deletes all flows created for a particular RSP and removes initialization flows from SFFs if the last RSP was removed.

Parameters:

rspId - the id of the RSP to be deleted

Returns:

Node IDs from which initialization flows were removed.

flushFlows

void flushFlows()

purgeFlows

void purgeFlows()

setFlowWriter

void setFlowWriter(SfcOfFlowWriterInterface sfcOfFlowWriter)

configureIpv4TransportIngressFlow

void configureIpv4TransportIngressFlow(String sffNodeName)

configureVlanTransportIngressFlow

void configureVlanTransportIngressFlow(String sffNodeName)

configureMacChainingTransportIngressFlow

void configureMacChainingTransportIngressFlow(String sffNodeName)

configureNshVxgpeSfLoopbackEncapsulatedEgressFlow

void configureNshVxgpeSfLoopbackEncapsulatedEgressFlow(String sffNodeName,
                                                       String sfIp,
                                                       short vxlanUdpPort,
                                                       long sffPort)

configureNshVxgpeSfReturnLoopbackIngressFlow

void configureNshVxgpeSfReturnLoopbackIngressFlow(String sffNodeName,
                                                  short vxlanUdpPort,
                                                  long sffPort)

configureNshVxgpeTransportIngressFlow

void configureNshVxgpeTransportIngressFlow(String sffNodeName,
                                           long nshNsp,
                                           short nshNsi)

configureMplsTransportIngressFlow

void configureMplsTransportIngressFlow(String sffNodeName)

configureArpTransportIngressFlow

void configureArpTransportIngressFlow(String sffNodeName,
                                      String mac)

configureMplsPathMapperFlow

void configureMplsPathMapperFlow(String sffNodeName,
                                 long label,
                                 long pathId,
                                 boolean isSf)

configureVlanPathMapperFlow

void configureVlanPathMapperFlow(String sffNodeName,
                                 int vlan,
                                 long pathId,
                                 boolean isSf)

configureMacNextHopFlow

void configureMacNextHopFlow(String sffNodeName,
                             long sfpId,
                             String srcMac,
                             String dstMac)

configureGroupNextHopFlow

void configureGroupNextHopFlow(String sffNodeName,
                               long sfpId,
                               String srcMac,
                               long groupId,
                               String groupName)

configureMacChainingNextHopFlow

void configureMacChainingNextHopFlow(String sffNodeName,
                                     String vmac,
                                     String dstSfMac,
                                     String nextVMac,
                                     boolean l2Tranparent)

configureNshVxgpeNextHopFlow

void configureNshVxgpeNextHopFlow(String sffNodeName,
                                  String dstIp,
                                  String nshProxyIp,
                                  long nsp,
                                  short nsi)

configureNshEthNextHopFlow

void configureNshEthNextHopFlow(String sffNodeName,
                                String srcMac,
                                String dstMac,
                                long nsp,
                                short nsi)

Configure nsh next hop flow.

Parameters:

sffNodeName - The openflow node name

srcMac - MAC address used by the openflow port to which the SF is connected

dstMac - MAC address used by the SF

nsp - the NSH NSP

nsi - the NSH NSI

configureVlanSfTransportEgressFlow

void configureVlanSfTransportEgressFlow(String sffNodeName,
                                        String srcMac,
                                        String dstMac,
                                        int dstVlan,
                                        String port,
                                        long pathId,
                                        boolean doPktin)

configureVlanTransportEgressFlow

void configureVlanTransportEgressFlow(String sffNodeName,
                                      String srcMac,
                                      String dstMac,
                                      int dstVlan,
                                      String port,
                                      long pathId)

configureMacChainingSfTransportEgressFlow

void configureMacChainingSfTransportEgressFlow(String sffNodeName,
                                               String dstMac,
                                               String port,
                                               String vmac)

configureVlanLastHopTransportEgressFlow

void configureVlanLastHopTransportEgressFlow(String sffNodeName,
                                             String srcMac,
                                             String dstMac,
                                             int dstVlan,
                                             String port,
                                             long pathId)

configureMplsTransportEgressFlow

void configureMplsTransportEgressFlow(String sffNodeName,
                                      String srcMac,
                                      String dstMac,
                                      long mplsLabel,
                                      String port,
                                      long pathId)

configureMplsLastHopTransportEgressFlow

void configureMplsLastHopTransportEgressFlow(String sffNodeName,
                                             String srcMac,
                                             String dstMac,
                                             long mplsLabel,
                                             String port,
                                             long pathId)

configureNshVxgpeTransportEgressFlow

void configureNshVxgpeTransportEgressFlow(String sffNodeName,
                                          long nshNsp,
                                          short nshNsi,
                                          String port)

configureNshVxgpeAppCoexistTransportEgressFlow

void configureNshVxgpeAppCoexistTransportEgressFlow(String sffNodeName,
                                                    long nshNsp,
                                                    short nshNsi,
                                                    String sffIp)

configureNshVxgpeLastHopTransportEgressFlow

void configureNshVxgpeLastHopTransportEgressFlow(String sffNodeName,
                                                 long nshNsp,
                                                 short nshNsi,
                                                 String port)

configureNshNscTransportEgressFlow

void configureNshNscTransportEgressFlow(String sffNodeName,
                                        long nshNsp,
                                        short nshNsi,
                                        String switchPort)

configureNshEthTransportEgressFlow

void configureNshEthTransportEgressFlow(String sffOpenFlowNodeName,
                                        long nshNsp,
                                        short nshNsi,
                                        List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action> actionList,
                                        String flowName)

Configure transport egress flows, using a list of externally provided actions.

Parameters:

sffOpenFlowNodeName - The openflow identifier for the node on which the flows are to be written

nshNsp - NSP to use in the match part

nshNsi - NSI to use in the match part

actionList - List of actions to use in the actions part

flowName - A unique flow name, also used as a flow key

configureNshEthTransportEgressFlow

void configureNshEthTransportEgressFlow(String sffNodeName,
                                        long nshNsp,
                                        short nshNsi,
                                        String port)

configureClassifierTableMatchAny

void configureClassifierTableMatchAny(String sffNodeName)

configureTransportIngressTableMatchAny

void configureTransportIngressTableMatchAny(String sffNodeName)

configureTransportIngressTableMatchAnyResubmit

void configureTransportIngressTableMatchAnyResubmit(String sffNodeName,
                                                    short nextTableId)

configurePathMapperTableMatchAny

void configurePathMapperTableMatchAny(String sffNodeName)

configurePathMapperAclTableMatchAny

void configurePathMapperAclTableMatchAny(String sffNodeName)

configureNextHopTableMatchAny

void configureNextHopTableMatchAny(String sffNodeName)

configureTransportEgressTableMatchAny

void configureTransportEgressTableMatchAny(String sffNodeName)

configureTransportEgressTableMatchAnyResubmit

void configureTransportEgressTableMatchAnyResubmit(String sffNodeName,
                                                   short nextTableId)

Set the match any flow in the Transport Egress table to resubmit.

Parameters:

sffNodeName - - the SFF to write the flow to

nextTableId - - the table to resubmit

configureClassifierTableDpdkOutput

void configureClassifierTableDpdkOutput(String sffNodeName,
                                        Long outPort)

configureClassifierTableDpdkInput

void configureClassifierTableDpdkInput(String sffNodeName,
                                       Long inPort)

configureGroup

void configureGroup(String sffNodeName,
                    String openflowNodeId,
                    String sfgName,
                    long sfgId,
                    int groupType,
                    List<GroupBucketInfo> bucketInfos,
                    boolean isAddGroup)

configureNshEthLastHopTransportEgressFlow

void configureNshEthLastHopTransportEgressFlow(String sffNodeName,
                                               org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress sffIpAddress,
                                               org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress sfMacAddress,
                                               long nshNsp,
                                               short nshNsi)

Used by logical sff processor in order to write chain egress flows. The sff ip address is optional, if not provided it is assumed that the sff has no dataplane tunnel endpoints.

Parameters:

sffNodeName - last openflow node in the chain

sffIpAddress - the sff ip address

sfMacAddress - the last sf mac address

nshNsp - nsp for the match

nshNsi - nsi for the match

setTableIndexMapper

void setTableIndexMapper(SfcTableIndexMapper tableIndexMapper)

Setter for the table index mapper (class which provides the tables to use for Genius-based application coexistence).

Parameters:

tableIndexMapper - The table index mapper