etri.sdn.controller.protocol

Class OFProtocol

java.lang.Object

etri.sdn.controller.protocol.OFProtocol

public class OFProtocol
extends java.lang.Object

This class is for handling Openflow protocol handshaking.

Author:

bjlee

Field Summary

Fields

Modifier and Type	Field and Description
private OFController	controller reference to OFController object.
private java.util.Map<IOFSwitch,java.util.Map<java.lang.Integer,PortInformation>>	portInformations Port Number to PortInformation map.
private java.util.Map<IOFSwitch,java.util.Map<java.lang.String,PortInformation>>	portInformationsByName Switch to map.
private java.lang.Object	portLock lock to synchronize.
private java.util.Map<IOFSwitch,java.util.Map<java.lang.Integer,java.lang.Object>>	responsesCache This field is used to exchange information with switch.
static java.lang.String	STR_DL_DST
static java.lang.String	STR_DL_SRC
static java.lang.String	STR_DL_TYPE
static java.lang.String	STR_DL_VLAN
static java.lang.String	STR_DL_VLAN_PCP
static java.lang.String	STR_IN_PORT
static java.lang.String	STR_NW_DST
static java.lang.String	STR_NW_PROTO
static java.lang.String	STR_NW_SRC
static java.lang.String	STR_NW_TOS
static java.lang.String	STR_TP_DST
static java.lang.String	STR_TP_SRC
private java.util.Map<IOFSwitch,SwitchInformation>	switchInformations IOFSwitch to SwitchInformation map.

Constructor Summary

Constructors

Constructor and Description
OFProtocol(OFController controller) Initialize OFProtocol object with OFController reference.

Method Summary

Methods

Modifier and Type	Method and Description
private PortInformation	createPortInformation(IOFSwitch sw, int port)
void	deletePort(IOFSwitch sw, int portNumber) Delete port information by the number
private void	deliverFeaturesReply(IOFSwitch sw, int xid, org.openflow.protocol.interfaces.OFFeaturesReply reply)
private void	deliverSwitchStatistics(IOFSwitch sw, org.openflow.protocol.interfaces.OFStatisticsReply m)
OFController	getController() Get reference to OFController object.
org.openflow.protocol.interfaces.OFStatisticsDescReply	getDescription(IOFSwitch sw) Get switch description as a OFStatisticsDescReply form
java.util.Collection<java.lang.Integer>	getEnabledPortNumbers(IOFSwitch sw) Get all the enabled port numbers
java.util.Collection<org.openflow.protocol.interfaces.OFPortDesc>	getEnabledPorts(IOFSwitch sw) Get all the enabled ports
org.openflow.protocol.interfaces.OFFeaturesReply	getFeaturesReply(IOFSwitch sw) Get OFFeaturesReply for the given switch.
org.openflow.protocol.interfaces.OFPortDesc	getPort(IOFSwitch sw, int portNum) Get port description as an OFPortDesc object
PortInformation	getPortInformation(IOFSwitch sw, int port) Get port information by the port number.
PortInformation	getPortInformationByName(IOFSwitch sw, java.lang.String name) This method should be called after port number is correctly set up.
java.util.Collection<PortInformation>	getPortInformations(IOFSwitch sw) Get all PortInformation objects for the given switch
java.util.Collection<PortInformation>	getPortInformations(long datapathId) Get all the PortInformation objects for the given switch by datapath id
java.util.Collection<org.openflow.protocol.interfaces.OFPortDesc>	getPorts(IOFSwitch sw) Get all port information as a collection of OFPortDesc objects
java.util.List<org.openflow.protocol.interfaces.OFPortDesc>	getPorts(long datapathId) Get all port information as a list of OFPortDesc objects (TODO: why not collection?)
java.lang.Object	getResponseCacheItem(IOFSwitch sw, int xid) This method is used with two other companion methods: setResponseCacheItem and removeResponseCacheItem.
SwitchInformation	getSwitchInformation(IOFSwitch sw) Get switch information
java.util.List<org.openflow.protocol.interfaces.OFStatisticsReply>	getSwitchStatistics(IOFSwitch sw, org.openflow.protocol.interfaces.OFStatisticsRequest req) Modules that use IOFSwitch objects use this method to request statistics to the switch.
boolean	handleConnectedEvent(Connection conn) Callback called by underlying platform when a connection to a switch is established
org.openflow.protocol.interfaces.OFMatch	loadOFMatchFromPacket(IOFSwitch sw, byte[] packetData, short inputPort) Create an OFMatch object from the packet-in data.
org.openflow.protocol.interfaces.OFMatch	loadOFMatchFromString(IOFSwitch sw, java.lang.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() 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"
boolean	portEnabled(IOFSwitch sw, short port) Check if a given port is enabled
boolean	portEnabled(org.openflow.protocol.interfaces.OFPortDesc port) Check if the given port is enabled
boolean	process(Connection conn, MessageContext context, org.openflow.protocol.OFMessage m) Callback called by underlying platform when a new OFMessage is received for a connection
void	removePortInformation(IOFSwitch sw, PortInformation pi) Remove a specific port information from the switch
void	removeResponseCacheItem(IOFSwitch sw, int xid) This method is used with two other companion methods: setResponseCacheItem and getResponseCacheItem.
void	setDescription(IOFSwitch sw, org.openflow.protocol.interfaces.OFStatisticsDescReply r) Modify switch description using OFStatisticsDescReply object
private void	setFromCIDR(org.openflow.protocol.interfaces.OFMatch.Builder match, java.lang.String cidr, java.lang.String which) Set the networkSource or networkDestionation address and their wildcards from the CIDR string
void	setPort(IOFSwitch sw, org.openflow.protocol.interfaces.OFPortDesc portDesc) Set port information using OFPortDesc object
void	setPortInformationByName(IOFSwitch sw, java.lang.String name, PortInformation pi) Set the port information
void	setResponseCacheItem(IOFSwitch sw, int xid, java.lang.Object item) This method is used with two other companion methods: getResponseCacheItem and removeResponseCacheItem.

Methods inherited from class java.lang.Object

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

Field Detail

STR_IN_PORT

public static final java.lang.String STR_IN_PORT

See Also:

Constant Field Values

STR_DL_DST

public static final java.lang.String STR_DL_DST

See Also:

Constant Field Values

STR_DL_SRC

public static final java.lang.String STR_DL_SRC

See Also:

Constant Field Values

STR_DL_TYPE

public static final java.lang.String STR_DL_TYPE

See Also:

Constant Field Values

STR_DL_VLAN

public static final java.lang.String STR_DL_VLAN

See Also:

Constant Field Values

STR_DL_VLAN_PCP

public static final java.lang.String STR_DL_VLAN_PCP

See Also:

Constant Field Values

STR_NW_DST

public static final java.lang.String STR_NW_DST

See Also:

Constant Field Values

STR_NW_SRC

public static final java.lang.String STR_NW_SRC

See Also:

Constant Field Values

STR_NW_PROTO

public static final java.lang.String STR_NW_PROTO

See Also:

Constant Field Values

STR_NW_TOS

public static final java.lang.String STR_NW_TOS

See Also:

Constant Field Values

STR_TP_DST

public static final java.lang.String STR_TP_DST

See Also:

Constant Field Values

STR_TP_SRC

public static final java.lang.String STR_TP_SRC

See Also:

Constant Field Values

switchInformations

private java.util.Map<IOFSwitch,SwitchInformation> switchInformations

IOFSwitch to SwitchInformation map.

portInformations

private java.util.Map<IOFSwitch,java.util.Map<java.lang.Integer,PortInformation>> portInformations

Port Number to PortInformation map.

portInformationsByName

private java.util.Map<IOFSwitch,java.util.Map<java.lang.String,PortInformation>> portInformationsByName

Switch to map.

responsesCache

private java.util.Map<IOFSwitch,java.util.Map<java.lang.Integer,java.lang.Object>> responsesCache

This field is used to exchange information with switch.

controller

private OFController controller

reference to OFController object.

portLock

private java.lang.Object portLock

lock to synchronize.

Constructor Detail

OFProtocol

public OFProtocol(OFController controller)

Initialize OFProtocol object with OFController reference.

Parameters:

controller - OFController object.

Method Detail

getController

public OFController getController()

Get reference to OFController object.

Returns:

OFController object.

setResponseCacheItem

public void setResponseCacheItem(IOFSwitch sw,
                        int xid,
                        java.lang.Object item)

This method is used with two other companion methods: getResponseCacheItem and removeResponseCacheItem.

Parameters:

sw - IOFSwitch object

xid - transaction id

item - object to set as a response for the transaction id

getResponseCacheItem

public java.lang.Object getResponseCacheItem(IOFSwitch sw,
                                    int xid)

This method is used with two other companion methods: setResponseCacheItem and removeResponseCacheItem.

Parameters:

sw - IOFSwitch object

xid - transaction id to get the response object

Returns:

Object set by setResponseCacheItem as a response for the transaction id

removeResponseCacheItem

public void removeResponseCacheItem(IOFSwitch sw,
                           int xid)

This method is used with two other companion methods: setResponseCacheItem and getResponseCacheItem.

Parameters:

sw - IOFSwitch object

xid - transaction id to remove the response object

getSwitchInformation

public SwitchInformation getSwitchInformation(IOFSwitch sw)

Get switch information

Parameters:

sw - Switch to retrieve the SwitchInformation object

Returns:

SwitchInformation object

getPortInformation

public PortInformation getPortInformation(IOFSwitch sw,
                                 int port)

Get port information by the port number. If none existent, null is returned.

Parameters:

sw - Switch to retrieve the port information

port - port number to retrieve the information

Returns:

PortInformation object

getPortInformations

public java.util.Collection<PortInformation> getPortInformations(IOFSwitch sw)

Get all PortInformation objects for the given switch

Parameters:

sw - IOFSwitch object

Returns:

Collection

getPortInformations

public java.util.Collection<PortInformation> getPortInformations(long datapathId)

Get all the PortInformation objects for the given switch by datapath id

Parameters:

datapathId - datapath id of the switch

Returns:

Collection

removePortInformation

public void removePortInformation(IOFSwitch sw,
                         PortInformation pi)

Remove a specific port information from the switch

Parameters:

sw - IOFSwitch object

pi - PortInformation object

getPortInformationByName

public PortInformation getPortInformationByName(IOFSwitch sw,
                                       java.lang.String name)

This method should be called after port number is correctly set up.

Parameters:

sw - IOFSwitch object

name - name of the port

Returns:

Null can be returned if the item that you looking for is non-existent

setPortInformationByName

public void setPortInformationByName(IOFSwitch sw,
                            java.lang.String name,
                            PortInformation pi)

Set the port information

Parameters:

sw - IOFSwitch object

name - port name

pi - PortInformation object

setDescription

public void setDescription(IOFSwitch sw,
                  org.openflow.protocol.interfaces.OFStatisticsDescReply r)

Modify switch description using OFStatisticsDescReply object

Parameters:

sw - IOFswitch object

r - OFStatisticsDescReply object

getDescription

public org.openflow.protocol.interfaces.OFStatisticsDescReply getDescription(IOFSwitch sw)

Get switch description as a OFStatisticsDescReply form

Parameters:

sw - IOFSwitch object

Returns:

OFStatisticsDescReply object

getPort

public org.openflow.protocol.interfaces.OFPortDesc getPort(IOFSwitch sw,
                                                  int portNum)

Get port description as an OFPortDesc object

Parameters:

sw - IOFSwitch object

portNum - port number

Returns:

OFPortDesc object

getPorts

public java.util.Collection<org.openflow.protocol.interfaces.OFPortDesc> getPorts(IOFSwitch sw)

Get all port information as a collection of OFPortDesc objects

Parameters:

sw - IOFSwitch object

Returns:

Collection

getPorts

public java.util.List<org.openflow.protocol.interfaces.OFPortDesc> getPorts(long datapathId)

Get all port information as a list of OFPortDesc objects (TODO: why not collection?)

Parameters:

datapathId - datapath id (long)

Returns:

List

setPort

public void setPort(IOFSwitch sw,
           org.openflow.protocol.interfaces.OFPortDesc portDesc)

Set port information using OFPortDesc object

Parameters:

sw - IOFSwitch object

portDesc - OFPortDesc object

createPortInformation

private PortInformation createPortInformation(IOFSwitch sw,
                                    int port)

deletePort

public void deletePort(IOFSwitch sw,
              int portNumber)

Delete port information by the number

Parameters:

sw - IOFSwitch object

portNumber - number of the port

handleConnectedEvent

public boolean handleConnectedEvent(Connection conn)

Callback called by underlying platform when a connection to a switch is established

Parameters:

conn - Connection object

Returns:

true if correctly handled (always)

process

public boolean process(Connection conn,
              MessageContext context,
              org.openflow.protocol.OFMessage m)

Callback called by underlying platform when a new OFMessage is received for a connection

Parameters:

conn - Connection object

context - MessageContext object created for the message

m - OFMessage object to handle

Returns:

true of correctly handled, false otherwise

getSwitchStatistics

public java.util.List<org.openflow.protocol.interfaces.OFStatisticsReply> getSwitchStatistics(IOFSwitch sw,
                                                                                     org.openflow.protocol.interfaces.OFStatisticsRequest req)

Modules that use IOFSwitch objects use this method to request statistics to the switch.

Parameters:

req - OFStatisticsRequest object.

deliverSwitchStatistics

private void deliverSwitchStatistics(IOFSwitch sw,
                           org.openflow.protocol.interfaces.OFStatisticsReply m)

getFeaturesReply

public org.openflow.protocol.interfaces.OFFeaturesReply getFeaturesReply(IOFSwitch sw)

Get OFFeaturesReply for the given switch.

Parameters:

sw - IOFSwitch object

Returns:

OFFeaturesReply object

deliverFeaturesReply

private void deliverFeaturesReply(IOFSwitch sw,
                        int xid,
                        org.openflow.protocol.interfaces.OFFeaturesReply reply)

getEnabledPorts

public java.util.Collection<org.openflow.protocol.interfaces.OFPortDesc> getEnabledPorts(IOFSwitch sw)

Get all the enabled ports

Parameters:

sw - IOFSwitch object

Returns:

Collection

getEnabledPortNumbers

public java.util.Collection<java.lang.Integer> getEnabledPortNumbers(IOFSwitch sw)

Get all the enabled port numbers

Parameters:

sw - IOFSwitch object

Returns:

Collection

portEnabled

public boolean portEnabled(org.openflow.protocol.interfaces.OFPortDesc port)

Check if the given port is enabled

Parameters:

port - OFPortDesc object

Returns:

true if enabled, false otherwise

portEnabled

public boolean portEnabled(IOFSwitch sw,
                  short port)

Check if a given port is enabled

Parameters:

sw - IOFSwitch object to which the port is bound

port - port number (short)

Returns:

true if enabled, false otherwise

loadOFMatchFromPacket

public org.openflow.protocol.interfaces.OFMatch loadOFMatchFromPacket(IOFSwitch sw,
                                                             byte[] packetData,
                                                             short inputPort)

Create an OFMatch object from the packet-in data. This method is called by doDropFlow and doForwardFlow of Forwarding module, and processPacketInMesssage of LearningMac module.

Parameters:

sw - IOFSwitch object

packetData - packet-in data array

inputPort - input port (short)

Returns:

OFMatch object

setFromCIDR

private void setFromCIDR(org.openflow.protocol.interfaces.OFMatch.Builder match,
               java.lang.String cidr,
               java.lang.String which)
                  throws java.lang.IllegalArgumentException

Set the networkSource or networkDestionation address and their wildcards from the CIDR string

Parameters:

cidr - "192.168.0.0/16" or "172.16.1.5"

which - one of STR_NW_DST or STR_NW_SRC

Throws:

java.lang.IllegalArgumentException

loadOFMatchFromString

public org.openflow.protocol.interfaces.OFMatch loadOFMatchFromString(IOFSwitch sw,
                                                             java.lang.String match)
                                                               throws java.lang.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"

Returns:

OFMatch object

Throws:

java.lang.IllegalArgumentException - on unexpected key or value