A net device that switches multiple LAN segments via an OpenFlow-compatible flow table. More...

#include <openflow-switch-net-device.h>

Inheritance diagram for ns3::OpenFlowSwitchNetDevice:

Collaboration diagram for ns3::OpenFlowSwitchNetDevice:

Public Member Functions
	OpenFlowSwitchNetDevice ()

virtual	~OpenFlowSwitchNetDevice ()

int	AddSwitchPort (Ptr< NetDevice > switchPort)
	Add a 'port' to a switch device. More...

int	AddVPort (const ofp_vport_mod *ovpm)
	Add a virtual port to a switch device. More...

void	DoOutput (uint32_t packet_uid, int in_port, size_t max_len, int out_port, bool ignore_no_fwd)
	Called from the OpenFlow Interface to output the Packet on either a Port or the Controller. More...

int	ForwardControlInput (const void *msg, size_t length)
	The registered controller calls this method when sending a message to the switch. More...

sw_chain *	GetChain ()

uint32_t	GetNSwitchPorts (void) const

ofi::Port	GetSwitchPort (uint32_t n) const

int	GetSwitchPortIndex (ofi::Port p)

vport_table_t	GetVPortTable ()

void	SetController (Ptr< ofi::Controller > c)
	Set up the Switch's controller connection. More...

void	StatsDone (ofi::StatsDumpCallback *cb_)
	Stats callback is done. More...

int	StatsDump (ofi::StatsDumpCallback *cb_)
	Stats callback is ready for a dump. More...

From NetDevice
virtual void	SetIfIndex (const uint32_t index)

virtual uint32_t	GetIfIndex (void) const

virtual Ptr< Channel >	GetChannel (void) const

virtual void	SetAddress (Address address)
	Set the address of this interface. More...

virtual Address	GetAddress (void) const

virtual bool	SetMtu (const uint16_t mtu)

virtual uint16_t	GetMtu (void) const

virtual bool	IsLinkUp (void) const

virtual void	AddLinkChangeCallback (Callback< void > callback)

virtual bool	IsBroadcast (void) const

virtual Address	GetBroadcast (void) const

virtual bool	IsMulticast (void) const

virtual Address	GetMulticast (Ipv4Address multicastGroup) const
	Make and return a MAC multicast address using the provided multicast group. More...

virtual bool	IsPointToPoint (void) const
	Return true if the net device is on a point-to-point link. More...

virtual bool	IsBridge (void) const
	Return true if the net device is acting as a bridge. More...

virtual bool	Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber)

virtual bool	SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)

virtual Ptr< Node >	GetNode (void) const

virtual void	SetNode (Ptr< Node > node)

virtual bool	NeedsArp (void) const

virtual void	SetReceiveCallback (NetDevice::ReceiveCallback cb)

virtual void	SetPromiscReceiveCallback (NetDevice::PromiscReceiveCallback cb)

virtual bool	SupportsSendFrom () const

virtual Address	GetMulticast (Ipv6Address addr) const
	Get the MAC multicast address corresponding to the IPv6 address provided. More...

Public Member Functions inherited from ns3::NetDevice
virtual	~NetDevice ()

Public Member Functions inherited from ns3::Object
	Object ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)

OpenFlowSwitchNetDevice Description Data
These four data describe the OpenFlowSwitchNetDevice as if it were a real OpenFlow switch. There is a type of stats request that OpenFlow switches are supposed to handle that returns the description of the OpenFlow switch. Currently manufactured by "The ns-3 team", software description is "Simulated OpenFlow Switch", and the other two are "N/A".
static const char *	GetManufacturerDescription ()

static const char *	GetHardwareDescription ()

static const char *	GetSoftwareDescription ()

static const char *	GetSerialNumber ()

Static Public Member Functions inherited from ns3::NetDevice
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Protected Member Functions
ofpbuf *	BufferFromPacket (Ptr< Packet > packet, Address src, Address dst, int mtu, uint16_t protocol)

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

void	ReceiveFromDevice (Ptr< NetDevice > netdev, Ptr< const Packet > packet, uint16_t protocol, const Address &src, const Address &dst, PacketType packetType)

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Private Types
typedef std::map< uint32_t, ofi::SwitchPacketMetadata >	PacketData_t

typedef std::vector< ofi::Port >	Ports_t

Private Member Functions

int AddFlow (const ofp_flow_mod *ofm)

void FillPortDesc (ofi::Port p, ofp_phy_port *desc)

void FlowTableLookup (sw_flow_key key, ofpbuf *buffer, uint32_t packet_uid, int port, bool send_to_controller)

void * MakeOpenflowReply (size_t openflow_len, uint8_t type, ofpbuf **bufferp)

int ModFlow (const ofp_flow_mod *ofm)

int OutputAll (uint32_t packet_uid, int in_port, bool flood)

void OutputControl (uint32_t packet_uid, int in_port, size_t max_len, int reason)

void OutputPacket (uint32_t packet_uid, int out_port)

void OutputPort (uint32_t packet_uid, int in_port, int out_port, bool ignore_no_fwd)

void RunThroughFlowTable (uint32_t packet_uid, int port, bool send_to_controller=true)

int RunThroughVPortTable (uint32_t packet_uid, int port, uint32_t vport)

void SendErrorMsg (uint16_t type, uint16_t code, const void *data, size_t len)

void SendFeaturesReply ()

void SendFlowExpired (sw_flow *flow, enum ofp_flow_expired_reason reason)

int SendOpenflowBuffer (ofpbuf *buffer)

void SendPortStatus (ofi::Port p, uint8_t status)

void SendVPortTableFeatures ()

int UpdatePortStatus (ofi::Port &p)

Receive Methods

Internal:

Actions to do when a specific OpenFlow message/packet is received

Parameters

msg	The OpenFlow message received.

Returns: 0 if everything's ok, otherwise an error number.

int ReceiveFeaturesRequest (const void *msg)

int ReceiveGetConfigRequest (const void *msg)

int ReceiveSetConfig (const void *msg)

int ReceivePacketOut (const void *msg)

int ReceiveFlow (const void *msg)

int ReceivePortMod (const void *msg)

int ReceiveStatsRequest (const void *oh)

int ReceiveEchoRequest (const void *oh)

int ReceiveEchoReply (const void *oh)

int ReceiveVPortMod (const void *msg)

int ReceiveVPortTableFeaturesRequest (const void *msg)

Private Attributes
Mac48Address	m_address
	Address of this device. More...

sw_chain *	m_chain
	Flow Table; forwarding rules. More...

Ptr< BridgeChannel >	m_channel
	Collection of port channels into the Switch Channel. More...

Ptr< ofi::Controller >	m_controller
	Connection to controller. More...

uint16_t	m_flags
	Flags; configurable by the controller. More...

uint64_t	m_id
	Unique identifier for this switch, needed for OpenFlow. More...

uint32_t	m_ifIndex
	Interface Index. More...

Time	m_lastExecute
	Last time the periodic execution occurred. More...

Time	m_lookupDelay
	Flow Table Lookup Delay [overhead]. More...

uint16_t	m_missSendLen
	Flow Table Miss Send Length; configurable by the controller. More...

uint16_t	m_mtu
	Maximum Transmission Unit. More...

Ptr< Node >	m_node
	Node this device is installed on. More...

PacketData_t	m_packetData
	Packet data. More...

Ports_t	m_ports
	Switch's ports. More...

NetDevice::PromiscReceiveCallback	m_promiscRxCallback

NetDevice::ReceiveCallback	m_rxCallback
	Callbacks. More...

vport_table_t	m_vportTable
	Virtual Port Table. More...

Additional Inherited Members
Public Types inherited from ns3::NetDevice
enum	PacketType { PACKET_HOST = 1, NS3_PACKET_HOST = PACKET_HOST, PACKET_BROADCAST, NS3_PACKET_BROADCAST = PACKET_BROADCAST, PACKET_MULTICAST, NS3_PACKET_MULTICAST = PACKET_MULTICAST, PACKET_OTHERHOST, NS3_PACKET_OTHERHOST = PACKET_OTHERHOST }
	Packet types are used as they are in Linux. More...

typedef Callback< bool, Ptr < NetDevice >, Ptr< const Packet >, uint16_t, const Address &, const Address &, enum PacketType >	PromiscReceiveCallback

typedef Callback< bool, Ptr < NetDevice >, Ptr< const Packet >, uint16_t, const Address & >	ReceiveCallback

Detailed Description

A net device that switches multiple LAN segments via an OpenFlow-compatible flow table.

The OpenFlowSwitchNetDevice object aggregates multiple netdevices as ports and acts like a switch. It implements OpenFlow-compatibility, according to the OpenFlow Switch Specification v0.8.9 <www.openflowswitch.org/documents/openflow-spec-v0.8.9.pdf>. It implements a flow table that all received packets are run through. It implements a connection to a controller via a subclass of the Controller class, which can send messages to manipulate the flow table, thereby manipulating how the OpenFlow switch behaves.

There are two controllers available in the original package. DropController builds a flow for each received packet to drop all packets it matches (this demonstrates the flow table's basic implementation), and the LearningController implements a "learning switch" algorithm (see 802.1D), where incoming unicast frames from one port may occasionally be forwarded throughout all other ports, but usually they are forwarded only to a single correct output port.

Attention: The Spanning Tree Protocol part of 802.1D is not implemented. Therefore, you have to be careful not to create bridging loops, or else the network will collapse.; Each NetDevice used must only be assigned a Mac Address, adding it to an Ipv4 or Ipv6 layer will cause an error. It also must support a SendFrom call.

A net device that switches multiple LAN segments via an OpenFlow-compatible flow table

Definition at line 86 of file openflow-switch-net-device.h.

Member Typedef Documentation

typedef std::map<uint32_t,ofi::SwitchPacketMetadata> ns3::OpenFlowSwitchNetDevice::PacketData_t

private

Definition at line 530 of file openflow-switch-net-device.h.

typedef std::vector<ofi::Port> ns3::OpenFlowSwitchNetDevice::Ports_t

private

Definition at line 533 of file openflow-switch-net-device.h.

Constructor & Destructor Documentation

ns3::OpenFlowSwitchNetDevice::OpenFlowSwitchNetDevice ( )

virtual ns3::OpenFlowSwitchNetDevice::~OpenFlowSwitchNetDevice ( )

virtual

Member Function Documentation

int ns3::OpenFlowSwitchNetDevice::AddFlow ( const ofp_flow_mod * ofm )

private

Internal:

Add a flow.

See also: #ENOMEM, #ENOBUFS, #ESRCH

Parameters

ofm	The flow data to add.

Returns: 0 if everything's ok, otherwise an error number.

virtual void ns3::OpenFlowSwitchNetDevice::AddLinkChangeCallback ( Callback< void > callback )

virtual

Parameters

callback the callback to invoke

Add a callback invoked whenever the link status changes to UP. This callback is typically used by the IP/ARP layer to flush the ARP cache and by IPv6 stack to flush NDISC cache whenever the link goes up.

Implements ns3::NetDevice.

int ns3::OpenFlowSwitchNetDevice::AddSwitchPort ( Ptr< NetDevice > switchPort )

Add a 'port' to a switch device.

This method adds a new switch port to a OpenFlowSwitchNetDevice, so that the new switch port NetDevice becomes part of the switch and L2 frames start being forwarded to/from this NetDevice.

Attention: The netdevice that is being added as switch port must not have an IP address. In order to add IP connectivity to a bridging node you must enable IP on the OpenFlowSwitchNetDevice itself, never on its port netdevices.

Parameters

switchPort The port to add.

Returns: 0 if everything's ok, otherwise an error number.

See also: #EXFULL

int ns3::OpenFlowSwitchNetDevice::AddVPort ( const ofp_vport_mod * ovpm )

Add a virtual port to a switch device.

The Ericsson OFSID has the concept of virtual ports and virtual port tables. These are implemented in the OpenFlowSwitchNetDevice, but don't have an understood use [perhaps it may have to do with MPLS integration].

See also: #EINVAL

Parameters

ovpm	The data for adding a virtual port.

Returns: 0 if everything's ok, otherwise an error number.

ofpbuf* ns3::OpenFlowSwitchNetDevice::BufferFromPacket	(	Ptr< Packet >	packet,
		Address	src,
		Address	dst,
		int	mtu,
		uint16_t	protocol
	)

protected

Internal:

Takes a packet and generates an OpenFlow buffer from it, loading the packet data as well as its headers.

Parameters

packet	The packet.
src	The source address.
dst	The destination address.
mtu	The Maximum Transmission Unit.
protocol	The protocol defining the packet.

Returns: The OpenFlow Buffer created from the packet.

virtual void ns3::OpenFlowSwitchNetDevice::DoDispose ( void )

protectedvirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

void ns3::OpenFlowSwitchNetDevice::DoOutput	(	uint32_t	packet_uid,
		int	in_port,
		size_t	max_len,
		int	out_port,
		bool	ignore_no_fwd
	)

Called from the OpenFlow Interface to output the Packet on either a Port or the Controller.

Parameters

packet_uid	Packet UID; used to fetch the packet and its metadata.
in_port	The index of the port the Packet was initially received on.
max_len	The maximum number of bytes the caller wants to be sent; a value of 0 indicates the entire packet should be sent. Used when outputting to controller.
out_port	The port we want to output on.
ignore_no_fwd	If true, Ports that are set to not forward are forced to forward.

void ns3::OpenFlowSwitchNetDevice::FillPortDesc	(	ofi::Port	p,
		ofp_phy_port *	desc
	)

private

Internal:

Fill out a description of the switch port.

Parameters

p	The port to get the description from.
desc	A pointer to the description message; used to fill the description message with the data from the port.

void ns3::OpenFlowSwitchNetDevice::FlowTableLookup	(	sw_flow_key	key,
		ofpbuf *	buffer,
		uint32_t	packet_uid,
		int	port,
		bool	send_to_controller
	)

private

Internal:

Called by RunThroughFlowTable on a scheduled delay to account for the flow table lookup overhead.

Parameters

key	Matching key to look up in the flow table.
buffer	Buffer of the packet received.
packet_uid	Packet UID; used to fetch the packet and its metadata.
port	The port the packet was received over.
send_to_controller

int ns3::OpenFlowSwitchNetDevice::ForwardControlInput	(	const void *	msg,
		size_t	length
	)

The registered controller calls this method when sending a message to the switch.

Parameters

msg	The message received from the controller.
length	Length of the message.

Returns: 0 if everything's ok, otherwise an error number.

virtual Address ns3::OpenFlowSwitchNetDevice::GetAddress ( void ) const

virtual

Returns: the current Address of this interface.

Implements ns3::NetDevice.

virtual Address ns3::OpenFlowSwitchNetDevice::GetBroadcast ( void ) const

virtual

Returns: the broadcast address supported by this netdevice.

Calling this method is invalid if IsBroadcast returns not true.

Implements ns3::NetDevice.

sw_chain* ns3::OpenFlowSwitchNetDevice::GetChain ( )

Returns: The flow table chain.

virtual Ptr<Channel> ns3::OpenFlowSwitchNetDevice::GetChannel ( void ) const

virtual

Returns: the channel this NetDevice is connected to. The value returned can be zero if the NetDevice is not yet connected to any channel or if the underlying NetDevice has no concept of a channel. i.e., callers must check for zero and be ready to handle it.

Implements ns3::NetDevice.

static const char* ns3::OpenFlowSwitchNetDevice::GetHardwareDescription ( )

static

virtual uint32_t ns3::OpenFlowSwitchNetDevice::GetIfIndex ( void ) const

virtual

Returns: index ifIndex of the device

Implements ns3::NetDevice.

static const char* ns3::OpenFlowSwitchNetDevice::GetManufacturerDescription ( )

static

virtual uint16_t ns3::OpenFlowSwitchNetDevice::GetMtu ( void ) const

virtual

Returns: the link-level MTU in bytes for this interface.

This value is typically used by the IP layer to perform IP fragmentation when needed.

Implements ns3::NetDevice.

virtual Address ns3::OpenFlowSwitchNetDevice::GetMulticast ( Ipv4Address multicastGroup ) const

virtual

Make and return a MAC multicast address using the provided multicast group.

RFC 1112 says that an Ipv4 host group address is mapped to an Ethernet multicast address by placing the low-order 23-bits of the IP address into the low-order 23 bits of the Ethernet multicast address 01-00-5E-00-00-00 (hex). Similar RFCs exist for Ipv6 and Eui64 mappings. This method performs the multicast address creation function appropriate to the underlying MAC address of the device. This MAC address is encapsulated in an abstract Address to avoid dependencies on the exact MAC address format.

In the case of net devices that do not support multicast, clients are expected to test NetDevice::IsMulticast and avoid attempting to map multicast packets. Subclasses of NetDevice that do support multicasting are expected to override this method and provide an implementation appropriate to the particular device.

Parameters

multicastGroup The IP address for the multicast group destination of the packet.

Returns: The MAC multicast Address used to send packets to the provided multicast group.

Warning: Calling this method is invalid if IsMulticast returns not true.

See also: Ipv4Address; Address; NetDevice::IsMulticast

Implements ns3::NetDevice.

virtual Address ns3::OpenFlowSwitchNetDevice::GetMulticast ( Ipv6Address addr ) const

virtual

Get the MAC multicast address corresponding to the IPv6 address provided.

Parameters

addr	IPv6 address

Returns: the MAC multicast address

Warning: Calling this method is invalid if IsMulticast returns not true.

Implements ns3::NetDevice.

virtual Ptr<Node> ns3::OpenFlowSwitchNetDevice::GetNode ( void ) const

virtual

Returns: the node base class which contains this network interface.

When a subclass needs to get access to the underlying node base class to print the nodeid for example, it can invoke this method.

Implements ns3::NetDevice.

uint32_t ns3::OpenFlowSwitchNetDevice::GetNSwitchPorts ( void ) const

Returns: Number of switch ports attached to this switch.

static const char* ns3::OpenFlowSwitchNetDevice::GetSerialNumber ( )

static

static const char* ns3::OpenFlowSwitchNetDevice::GetSoftwareDescription ( )

static

ofi::Port ns3::OpenFlowSwitchNetDevice::GetSwitchPort ( uint32_t n ) const

Parameters

n	index of the Port.

Returns: The Port.

int ns3::OpenFlowSwitchNetDevice::GetSwitchPortIndex ( ofi::Port p )

Parameters

p	The Port to get the index of.

Returns: The index of the provided Port.

static TypeId ns3::OpenFlowSwitchNetDevice::GetTypeId ( void )

static

vport_table_t ns3::OpenFlowSwitchNetDevice::GetVPortTable ( )

Returns: The virtual port table.

virtual bool ns3::OpenFlowSwitchNetDevice::IsBridge ( void ) const

virtual

Return true if the net device is acting as a bridge.

Returns: value of m_isBridge flag

Implements ns3::NetDevice.

virtual bool ns3::OpenFlowSwitchNetDevice::IsBroadcast ( void ) const

virtual

Returns: true if this interface supports a broadcast address, false otherwise.

Implements ns3::NetDevice.

virtual bool ns3::OpenFlowSwitchNetDevice::IsLinkUp ( void ) const

virtual

Returns: true if link is up; false otherwise

Implements ns3::NetDevice.

virtual bool ns3::OpenFlowSwitchNetDevice::IsMulticast ( void ) const

virtual

Returns: value of m_isMulticast flag

Implements ns3::NetDevice.

virtual bool ns3::OpenFlowSwitchNetDevice::IsPointToPoint ( void ) const

virtual

Return true if the net device is on a point-to-point link.

Returns: value of m_isPointToPoint flag

Implements ns3::NetDevice.

void* ns3::OpenFlowSwitchNetDevice::MakeOpenflowReply	(	size_t	openflow_len,
		uint8_t	type,
		ofpbuf **	bufferp
	)

private

Internal:

Generates an OpenFlow reply message based on the type.

Parameters

openflow_len	Length of the reply to make.
type	Type of reply message to make.
bufferp	Message buffer; used to make the reply.

Returns: The OpenFlow reply message.

int ns3::OpenFlowSwitchNetDevice::ModFlow ( const ofp_flow_mod * ofm )

private

Internal:

Modify a flow.

Parameters

ofm	The flow data to modify.

Returns: 0 if everything's ok, otherwise an error number.

virtual bool ns3::OpenFlowSwitchNetDevice::NeedsArp ( void ) const

virtual

Returns: true if ARP is needed, false otherwise.

Called by higher-layers to check if this NetDevice requires ARP to be used.

Implements ns3::NetDevice.

int ns3::OpenFlowSwitchNetDevice::OutputAll	(	uint32_t	packet_uid,
		int	in_port,
		bool	flood
	)

private

Internal:

Send packets out all the ports except the originating one

Parameters

packet_uid	Packet UID; used to fetch the packet and its metadata.
in_port	The index of the port the Packet was initially received on. This port doesn't forward when flooding.
flood	If true, don't send out on the ports with flooding disabled.

Returns: 0 if everything's ok, otherwise an error number.

void ns3::OpenFlowSwitchNetDevice::OutputControl	(	uint32_t	packet_uid,
		int	in_port,
		size_t	max_len,
		int	reason
	)

private

Internal:

Sends a copy of the Packet to the controller. If the packet can be saved in an OpenFlow buffer, then only the first 'max_len' bytes of the packet are sent; otherwise, all of the packet is sent.

Parameters

packet_uid	Packet UID; used to fetch the packet and its metadata.
in_port	The index of the port the Packet was initially received on.
max_len	The maximum number of bytes that the caller wants to be sent; a value of 0 indicates the entire packet should be sent.
reason	Why the packet is being sent.

void ns3::OpenFlowSwitchNetDevice::OutputPacket	(	uint32_t	packet_uid,
		int	out_port
	)

private

Internal:

Sends a copy of the Packet over the provided output port

Parameters

packet_uid Packet UID; used to fetch the packet and its metadata.

void ns3::OpenFlowSwitchNetDevice::OutputPort	(	uint32_t	packet_uid,
		int	in_port,
		int	out_port,
		bool	ignore_no_fwd
	)

private

Internal:

Seeks to send out a Packet over the provided output port. This is called generically when we may or may not know the specific port we're outputting on. There are many pre-set types of port options besides a Port that's hooked to our OpenFlowSwitchNetDevice. For example, it could be outputting as a flood, or seeking to output to the controller.

Parameters

packet_uid	Packet UID; used to fetch the packet and its metadata.
in_port	The index of the port the Packet was initially received on.
out_port	The port we want to output on.
ignore_no_fwd	If true, Ports that are set to not forward are forced to forward.

int ns3::OpenFlowSwitchNetDevice::ReceiveEchoReply ( const void * oh )

private

int ns3::OpenFlowSwitchNetDevice::ReceiveEchoRequest ( const void * oh )

private

int ns3::OpenFlowSwitchNetDevice::ReceiveFeaturesRequest ( const void * msg )

private

int ns3::OpenFlowSwitchNetDevice::ReceiveFlow ( const void * msg )

private

void ns3::OpenFlowSwitchNetDevice::ReceiveFromDevice	(	Ptr< NetDevice >	netdev,
		Ptr< const Packet >	packet,
		uint16_t	protocol,
		const Address &	src,
		const Address &	dst,
		PacketType	packetType
	)

protected

Internal:

Called when a packet is received on one of the switch's ports.

Parameters

netdev	The port the packet was received on.
packet	The Packet itself.
protocol	The protocol defining the Packet.
src	The source address of the Packet.
dst	The destination address of the Packet.
PacketType	Type of the packet.

int ns3::OpenFlowSwitchNetDevice::ReceiveGetConfigRequest ( const void * msg )

private

int ns3::OpenFlowSwitchNetDevice::ReceivePacketOut ( const void * msg )

private

int ns3::OpenFlowSwitchNetDevice::ReceivePortMod ( const void * msg )

private

int ns3::OpenFlowSwitchNetDevice::ReceiveSetConfig ( const void * msg )

private

int ns3::OpenFlowSwitchNetDevice::ReceiveStatsRequest ( const void * oh )

private

int ns3::OpenFlowSwitchNetDevice::ReceiveVPortMod ( const void * msg )

private

int ns3::OpenFlowSwitchNetDevice::ReceiveVPortTableFeaturesRequest ( const void * msg )

private

void ns3::OpenFlowSwitchNetDevice::RunThroughFlowTable	(	uint32_t	packet_uid,
		int	port,
		bool	send_to_controller = `true`
	)

private

Internal:

Run the packet through the flow table. Looks up in the flow table for a match. If it doesn't match, it forwards the packet to the registered controller, if the flag is set.

Parameters

packet_uid	Packet UID; used to fetch the packet and its metadata.
port	The port this packet was received over.
send_to_controller	If set, sends to the controller if the packet isn't matched.

int ns3::OpenFlowSwitchNetDevice::RunThroughVPortTable	(	uint32_t	packet_uid,
		int	port,
		uint32_t	vport
	)

private

Internal:

Run the packet through the vport table. As with AddVPort, this doesn't have an understood use yet.

Parameters

packet_uid	Packet UID; used to fetch the packet and its metadata.
port	The port this packet was received over.
vport	The virtual port this packet identifies itself by.

Returns: 0 if everything's ok, otherwise an error number.

virtual bool ns3::OpenFlowSwitchNetDevice::Send	(	Ptr< Packet >	packet,
		const Address &	dest,
		uint16_t	protocolNumber
	)

virtual

Parameters

packet	packet sent from above down to Network Device
dest	mac address of the destination (already resolved)
protocolNumber	identifies the type of payload contained in this packet. Used to call the right L3Protocol when the packet is received.

Called from higher layer to send packet into Network Device to the specified destination Address

Returns: whether the Send operation succeeded

Implements ns3::NetDevice.

void ns3::OpenFlowSwitchNetDevice::SendErrorMsg	(	uint16_t	type,
		uint16_t	code,
		const void *	data,
		size_t	len
	)

private

Internal:

If an error message happened during the controller's request, send it to the controller.

Parameters

type	The type of error.
code	The error code.
data	The faulty data that lead to the error.
len	The length of the faulty data.

void ns3::OpenFlowSwitchNetDevice::SendFeaturesReply ( )

private

Internal:

Send a reply about this OpenFlow switch's features to the controller.

List of capabilities and actions to support are found in the specification <www.openflowswitch.org/documents/openflow-spec-v0.8.9.pdf>.

Supported capabilities and actions are defined in the openflow interface. To recap, flow status, flow table status, port status, virtual port table status can all be requested. It can also transmit over multiple physical interfaces.

It supports every action: outputting over a port, and all of the flow table manipulation actions: setting the 802.1q VLAN ID, the 802.1q priority, stripping the 802.1 header, setting the Ethernet source address and destination, setting the IP source address and destination, setting the TCP/UDP source address and destination, and setting the MPLS label and EXP bits.

Attention: Capabilities STP (Spanning Tree Protocol) and IP packet reassembly are not currently supported.

void ns3::OpenFlowSwitchNetDevice::SendFlowExpired	(	sw_flow *	flow,
		enum ofp_flow_expired_reason	reason
	)

private

Internal:

Send a reply to the controller that a specific flow has expired.

Parameters

flow	The flow that expired.
reason	The reason for sending this expiration notification.

virtual bool ns3::OpenFlowSwitchNetDevice::SendFrom	(	Ptr< Packet >	packet,
		const Address &	source,
		const Address &	dest,
		uint16_t	protocolNumber
	)

virtual

Parameters

packet	packet sent from above down to Network Device
source	source mac address (so called "MAC spoofing")
dest	mac address of the destination (already resolved)
protocolNumber	identifies the type of payload contained in this packet. Used to call the right L3Protocol when the packet is received.

Called from higher layer to send packet into Network Device with the specified source and destination Addresses.

Returns: whether the Send operation succeeded

Implements ns3::NetDevice.

int ns3::OpenFlowSwitchNetDevice::SendOpenflowBuffer ( ofpbuf * buffer )

private

Internal:

Send a message to the controller. This method is the key to communicating with the controller, it does the actual sending. The other Send methods call this one when they are ready to send a message.

Parameters

buffer Buffer of the message to send out.

Returns: 0 if successful, otherwise an error number.

void ns3::OpenFlowSwitchNetDevice::SendPortStatus	(	ofi::Port	p,
		uint8_t	status
	)

private

Internal:

Send a reply about a Port's status to the controller.

Parameters

p	The port to get status from.
status	The reason for sending this reply.

void ns3::OpenFlowSwitchNetDevice::SendVPortTableFeatures ( )

private

Internal:

Send a reply about this OpenFlow switch's virtual port table features to the controller.

virtual void ns3::OpenFlowSwitchNetDevice::SetAddress ( Address address )

virtual

Set the address of this interface.

Parameters

address address to set

Implements ns3::NetDevice.

void ns3::OpenFlowSwitchNetDevice::SetController ( Ptr< ofi::Controller > c )

Set up the Switch's controller connection.

Parameters

c	Pointer to a Controller.

virtual void ns3::OpenFlowSwitchNetDevice::SetIfIndex ( const uint32_t index )

virtual

Parameters

index ifIndex of the device

Implements ns3::NetDevice.

virtual bool ns3::OpenFlowSwitchNetDevice::SetMtu ( const uint16_t mtu )

virtual

Parameters

mtu	MTU value, in bytes, to set for the device

Returns: whether the MTU value was within legal bounds

Override for default MTU defined on a per-type basis.

Implements ns3::NetDevice.

virtual void ns3::OpenFlowSwitchNetDevice::SetNode ( Ptr< Node > node )

virtual

Parameters

node	the node associated to this netdevice.

This method is called from ns3::Node::AddDevice.

Implements ns3::NetDevice.

virtual void ns3::OpenFlowSwitchNetDevice::SetPromiscReceiveCallback ( NetDevice::PromiscReceiveCallback cb )

virtual

Parameters

cb	callback to invoke whenever a packet has been received in promiscuous mode and must be forwarded to the higher layers.

Enables netdevice promiscuous mode and sets the callback that will handle promiscuous mode packets. Note, promiscuous mode packets means all packets, including those packets that can be sensed by the netdevice but which are intended to be received by other hosts.

Implements ns3::NetDevice.

virtual void ns3::OpenFlowSwitchNetDevice::SetReceiveCallback ( NetDevice::ReceiveCallback cb )

virtual

Parameters