org.openflow.protocol

Class OFMatch

java.lang.Object

org.openflow.protocol.OFMatch

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

OVXMatch

public class OFMatch
extends Object
implements Cloneable, Serializable

Represents an ofp_match structure

Author:

David Erickson (daviderickson@cs.stanford.edu), Rob Sherwood (rob.sherwood@stanford.edu)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	dataLayerDestination
protected byte[]	dataLayerSource
protected short	dataLayerType
protected short	dataLayerVirtualLan
protected byte	dataLayerVirtualLanPriorityCodePoint
protected short	inputPort
static int	MINIMUM_LENGTH
protected int	networkDestination
protected byte	networkProtocol
protected int	networkSource
protected byte	networkTypeOfService
static int	OFPFW_ALL
static int	OFPFW_ALL_SANITIZED
static int	OFPFW_DL_DST
static int	OFPFW_DL_SRC
static int	OFPFW_DL_TYPE
static int	OFPFW_DL_VLAN
static int	OFPFW_DL_VLAN_PCP
static int	OFPFW_IN_PORT
static int	OFPFW_NW_DST_ALL
static int	OFPFW_NW_DST_BITS
static int	OFPFW_NW_DST_MASK
static int	OFPFW_NW_DST_SHIFT
static int	OFPFW_NW_PROTO
static int	OFPFW_NW_SRC_ALL
static int	OFPFW_NW_SRC_BITS
static int	OFPFW_NW_SRC_MASK
static int	OFPFW_NW_SRC_SHIFT
static int	OFPFW_NW_TOS
static int	OFPFW_TP_DST
static int	OFPFW_TP_SRC
static String	STR_DL_DST
static String	STR_DL_SRC
static String	STR_DL_TYPE
static String	STR_DL_VLAN
static String	STR_DL_VLAN_PCP
static String	STR_IN_PORT
static String	STR_NW_DST
static String	STR_NW_PROTO
static String	STR_NW_SRC
static String	STR_NW_TOS
static String	STR_TP_DST
static String	STR_TP_SRC
protected short	transportDestination
protected short	transportSource
protected int	wildcards

Constructor Summary

Constructors

Constructor and Description
OFMatch() By default, create a OFMatch that matches everything (mostly because it's the least amount of work to make a valid OFMatch)

Method Summary

Methods

Modifier and Type	Method and Description
OFMatch	clone() Implement clonable interface
static String	debugWildCards(int wildcards) debug a set of wildcards
boolean	equals(Object obj)
void	fromString(String match) Set this OFMatch's parameters based on a comma-separated key=value pair dpctl-style string, e.g., from the output of OFMatch.toString()
byte[]	getDataLayerDestination() Get dl_dst
byte[]	getDataLayerSource() Get dl_src
short	getDataLayerType() Get dl_type
short	getDataLayerVirtualLan() Get dl_vlan
byte	getDataLayerVirtualLanPriorityCodePoint() Get dl_vlan_pcp
short	getInputPort() Get in_port
int	getNetworkDestination() Get nw_dst
int	getNetworkDestinationMaskLen() Parse this match's wildcard fields and return the number of significant bits in the IP destination field.
byte	getNetworkProtocol() Get nw_proto
int	getNetworkSource() Get nw_src
int	getNetworkSourceMaskLen() Parse this match's wildcard fields and return the number of significant bits in the IP destination field.
byte	getNetworkTypeOfService() Get nw_tos OFMatch stores the ToS bits as top 6-bits, so right shift by 2 bits before returning the value
short	getTransportDestination() Get tp_dst
short	getTransportSource() Get tp_src
Wildcards	getWildcardObj() Get wildcards
int	getWildcards() Get wildcards
int	hashCode()
protected static String	ipToString(int ip)
OFMatch	loadFromPacket(byte[] packetData, short inputPort) Initializes this OFMatch structure with the corresponding data from the specified packet.
void	readFrom(org.jboss.netty.buffer.ChannelBuffer data) Read this message off the wire from the specified ByteBuffer
OFMatch	setDataLayerDestination(byte[] dataLayerDestination) Set dl_dst
OFMatch	setDataLayerDestination(String mac) Set dl_dst, but first translate to byte[] using HexString
OFMatch	setDataLayerSource(byte[] dataLayerSource) Set dl_src
OFMatch	setDataLayerSource(String mac) Set dl_src, but first translate to byte[] using HexString
OFMatch	setDataLayerType(short dataLayerType) Set dl_type
OFMatch	setDataLayerVirtualLan(short dataLayerVirtualLan) Set dl_vlan
OFMatch	setDataLayerVirtualLanPriorityCodePoint(byte pcp) Set dl_vlan_pcp
OFMatch	setInputPort(short inputPort) Set in_port
OFMatch	setNetworkDestination(int networkDestination) Set nw_dst
OFMatch	setNetworkProtocol(byte networkProtocol) Set nw_proto
OFMatch	setNetworkSource(int networkSource) Set nw_src
OFMatch	setNetworkTypeOfService(byte networkTypeOfService) Set nw_tos OFMatch stores the ToS bits as top 6-bits, so left shift by 2 bits before storing the value
OFMatch	setTransportDestination(short transportDestination) Set tp_dst
OFMatch	setTransportSource(short transportSource) Set tp_src
OFMatch	setWildcards(int wildcards) Set wildcards
OFMatch	setWildcards(Wildcards wildcards) set the wildcard using the Wildcards convenience object
String	toString() Output a dpctl-styled string, i.e., only list the elements that are not wildcarded A match-everything OFMatch outputs "OFMatch[]"
String	toStringUnmasked() Return a string including all match fields, regardless whether they are wildcarded or not.
void	writeTo(org.jboss.netty.buffer.ChannelBuffer data) Write this message's binary format to the specified ByteBuffer

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MINIMUM_LENGTH

public static int MINIMUM_LENGTH

OFPFW_ALL

public static final int OFPFW_ALL

See Also:

Constant Field Values

OFPFW_IN_PORT

public static final int OFPFW_IN_PORT

See Also:

Constant Field Values

OFPFW_DL_VLAN

public static final int OFPFW_DL_VLAN

See Also:

Constant Field Values

OFPFW_DL_SRC

public static final int OFPFW_DL_SRC

See Also:

Constant Field Values

OFPFW_DL_DST

public static final int OFPFW_DL_DST

See Also:

Constant Field Values

OFPFW_DL_TYPE

public static final int OFPFW_DL_TYPE

See Also:

Constant Field Values

OFPFW_NW_PROTO

public static final int OFPFW_NW_PROTO

See Also:

Constant Field Values

OFPFW_TP_SRC

public static final int OFPFW_TP_SRC

See Also:

Constant Field Values

OFPFW_TP_DST

public static final int OFPFW_TP_DST

See Also:

Constant Field Values

OFPFW_NW_SRC_SHIFT

public static final int OFPFW_NW_SRC_SHIFT

See Also:

Constant Field Values

OFPFW_NW_SRC_BITS

public static final int OFPFW_NW_SRC_BITS

See Also:

Constant Field Values

OFPFW_NW_SRC_MASK

public static final int OFPFW_NW_SRC_MASK

See Also:

Constant Field Values

OFPFW_NW_SRC_ALL

public static final int OFPFW_NW_SRC_ALL

See Also:

Constant Field Values

OFPFW_NW_DST_SHIFT

public static final int OFPFW_NW_DST_SHIFT

See Also:

Constant Field Values

OFPFW_NW_DST_BITS

public static final int OFPFW_NW_DST_BITS

See Also:

Constant Field Values

OFPFW_NW_DST_MASK

public static final int OFPFW_NW_DST_MASK

See Also:

Constant Field Values

OFPFW_NW_DST_ALL

public static final int OFPFW_NW_DST_ALL

See Also:

Constant Field Values

OFPFW_DL_VLAN_PCP

public static final int OFPFW_DL_VLAN_PCP

See Also:

Constant Field Values

OFPFW_NW_TOS

public static final int OFPFW_NW_TOS

See Also:

Constant Field Values

OFPFW_ALL_SANITIZED

public static final int OFPFW_ALL_SANITIZED

See Also:

Constant Field Values

STR_IN_PORT

public static final String STR_IN_PORT

See Also:

Constant Field Values

STR_DL_DST

public static final String STR_DL_DST

See Also:

Constant Field Values

STR_DL_SRC

public static final String STR_DL_SRC

See Also:

Constant Field Values

STR_DL_TYPE

public static final String STR_DL_TYPE

See Also:

Constant Field Values

STR_DL_VLAN

public static final String STR_DL_VLAN

See Also:

Constant Field Values

STR_DL_VLAN_PCP

public static final String STR_DL_VLAN_PCP

See Also:

Constant Field Values

STR_NW_DST

public static final String STR_NW_DST

See Also:

Constant Field Values

STR_NW_SRC

public static final String STR_NW_SRC

See Also:

Constant Field Values

STR_NW_PROTO

public static final String STR_NW_PROTO

See Also:

Constant Field Values

STR_NW_TOS

public static final String STR_NW_TOS

See Also:

Constant Field Values

STR_TP_DST

public static final String STR_TP_DST

See Also:

Constant Field Values

STR_TP_SRC

public static final String STR_TP_SRC

See Also:

Constant Field Values

wildcards

protected int wildcards

inputPort

protected short inputPort

dataLayerSource

protected byte[] dataLayerSource

dataLayerDestination

protected byte[] dataLayerDestination

dataLayerVirtualLan

protected short dataLayerVirtualLan

dataLayerVirtualLanPriorityCodePoint

protected byte dataLayerVirtualLanPriorityCodePoint

dataLayerType

protected short dataLayerType

networkTypeOfService

protected byte networkTypeOfService

networkProtocol

protected byte networkProtocol

networkSource

protected int networkSource

networkDestination

protected int networkDestination

transportSource

protected short transportSource

transportDestination

protected short transportDestination

Constructor Detail

OFMatch

public OFMatch()

By default, create a OFMatch that matches everything (mostly because it's the least amount of work to make a valid OFMatch)

Method Detail

getDataLayerDestination

public byte[] getDataLayerDestination()

Get dl_dst

Returns:

an arrays of bytes

setDataLayerDestination

public OFMatch setDataLayerDestination(byte[] dataLayerDestination)

Set dl_dst

Parameters:

dataLayerDestination -

setDataLayerDestination

public OFMatch setDataLayerDestination(String mac)

Set dl_dst, but first translate to byte[] using HexString

Parameters:

mac - A colon separated string of 6 pairs of octets, e..g., "00:17:42:EF:CD:8D"

getDataLayerSource

public byte[] getDataLayerSource()

Get dl_src

Returns:

an array of bytes

setDataLayerSource

public OFMatch setDataLayerSource(byte[] dataLayerSource)

Set dl_src

Parameters:

dataLayerSource -

setDataLayerSource

public OFMatch setDataLayerSource(String mac)

Set dl_src, but first translate to byte[] using HexString

Parameters:

mac - A colon separated string of 6 pairs of octets, e..g., "00:17:42:EF:CD:8D"

getDataLayerType

public short getDataLayerType()

Get dl_type

Returns:

ether_type

setDataLayerType

public OFMatch setDataLayerType(short dataLayerType)

Set dl_type

Parameters:

dataLayerType -

getDataLayerVirtualLan

public short getDataLayerVirtualLan()

Get dl_vlan

Returns:

vlan tag; VLAN_NONE == no tag

setDataLayerVirtualLan

public OFMatch setDataLayerVirtualLan(short dataLayerVirtualLan)

Set dl_vlan

Parameters:

dataLayerVirtualLan -

getDataLayerVirtualLanPriorityCodePoint

public byte getDataLayerVirtualLanPriorityCodePoint()

Get dl_vlan_pcp

Returns:

setDataLayerVirtualLanPriorityCodePoint

public OFMatch setDataLayerVirtualLanPriorityCodePoint(byte pcp)

Set dl_vlan_pcp

Parameters:

pcp -

getInputPort

public short getInputPort()

Get in_port

Returns:

setInputPort

public OFMatch setInputPort(short inputPort)

Set in_port

Parameters:

inputPort -

getNetworkDestination

public int getNetworkDestination()

Get nw_dst

Returns:

setNetworkDestination

public OFMatch setNetworkDestination(int networkDestination)

Set nw_dst

Parameters:

networkDestination -

getNetworkDestinationMaskLen

public int getNetworkDestinationMaskLen()

Parse this match's wildcard fields and return the number of significant bits in the IP destination field. NOTE: this returns the number of bits that are fixed, i.e., like CIDR, not the number of bits that are free like OpenFlow encodes.

Returns:

a number between 0 (matches all IPs) and 63 ( 32>= implies exact match)

getNetworkSourceMaskLen

public int getNetworkSourceMaskLen()

Parse this match's wildcard fields and return the number of significant bits in the IP destination field. NOTE: this returns the number of bits that are fixed, i.e., like CIDR, not the number of bits that are free like OpenFlow encodes.

Returns:

a number between 0 (matches all IPs) and 32 (exact match)

getNetworkProtocol

public byte getNetworkProtocol()

Get nw_proto

Returns:

setNetworkProtocol

public OFMatch setNetworkProtocol(byte networkProtocol)

Set nw_proto

Parameters:

networkProtocol -

getNetworkSource

public int getNetworkSource()

Get nw_src

Returns:

setNetworkSource

public OFMatch setNetworkSource(int networkSource)

Set nw_src

Parameters:

networkSource -

getNetworkTypeOfService

public byte getNetworkTypeOfService()

Get nw_tos OFMatch stores the ToS bits as top 6-bits, so right shift by 2 bits before returning the value

Returns:

: 6-bit DSCP value (0-63)

setNetworkTypeOfService

public OFMatch setNetworkTypeOfService(byte networkTypeOfService)

Set nw_tos OFMatch stores the ToS bits as top 6-bits, so left shift by 2 bits before storing the value

Parameters:

networkTypeOfService - : 6-bit DSCP value (0-63)

getTransportDestination

public short getTransportDestination()

Get tp_dst

Returns:

setTransportDestination

public OFMatch setTransportDestination(short transportDestination)

Set tp_dst

Parameters:

transportDestination -

getTransportSource

public short getTransportSource()

Get tp_src

Returns:

setTransportSource

public OFMatch setTransportSource(short transportSource)

Set tp_src

Parameters:

transportSource -

getWildcards

public int getWildcards()

Get wildcards

Returns:

getWildcardObj

public Wildcards getWildcardObj()

Get wildcards

Returns:

setWildcards

public OFMatch setWildcards(int wildcards)

Set wildcards

Parameters:

wildcards -

setWildcards

public OFMatch setWildcards(Wildcards wildcards)

set the wildcard using the Wildcards convenience object

loadFromPacket

public OFMatch loadFromPacket(byte[] packetData,
                     short inputPort)

Initializes this OFMatch structure with the corresponding data from the specified packet. Must specify the input port, to ensure that this.in_port is set correctly. Specify OFPort.NONE or OFPort.ANY if input port not applicable or available

Parameters:

packetData - The packet's data

inputPort - the port the packet arrived on

readFrom

public void readFrom(org.jboss.netty.buffer.ChannelBuffer data)

Read this message off the wire from the specified ByteBuffer

Parameters:

data -

writeTo

public void writeTo(org.jboss.netty.buffer.ChannelBuffer data)

Write this message's binary format to the specified ByteBuffer

Parameters:

data -

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public OFMatch clone()

Implement clonable interface

Overrides:

clone in class Object

toString

public String toString()

Output a dpctl-styled string, i.e., only list the elements that are not wildcarded A match-everything OFMatch outputs "OFMatch[]"

Overrides:

toString in class Object

Returns:

"OFMatch[dl_src:00:20:01:11:22:33,nw_src:192.168.0.0/24,tp_dst:80]"

toStringUnmasked

public String toStringUnmasked()

Return a string including all match fields, regardless whether they are wildcarded or not.

debugWildCards

public static String debugWildCards(int wildcards)

debug a set of wildcards

fromString

public void fromString(String match)
                throws IllegalArgumentException

Set this OFMatch's parameters based on a comma-separated key=value pair dpctl-style string, e.g., from the output of OFMatch.toString()

Supported keys/values include

KEY(s)	VALUE
"in_port","input_port"	integer
"dl_src","eth_src", "dl_dst","eth_dst"	hex-string
"dl_type", "dl_vlan", "dl_vlan_pcp"	integer
"nw_src", "nw_dst", "ip_src", "ip_dst"	CIDR-style netmask
"tp_src","tp_dst"	integer (max 64k)

The CIDR-style netmasks assume 32 netmask if none given, so: "128.8.128.118/32" is the same as "128.8.128.118"

Parameters:

match - a key=value comma separated string, e.g. "in_port=5,ip_dst=192.168.0.0/16,tp_src=80"

Throws:

IllegalArgumentException - on unexpected key or value

ipToString

protected static String ipToString(int ip)