ns-3
ns3::OpenFlowSwitchNetDevice Class Reference

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:

List of all members.

Public Member Functions

void SetController (Ptr< ofi::Controller > c)
 Set up the Switch's controller connection.
int AddSwitchPort (Ptr< NetDevice > switchPort)
 Add a 'port' to a switch device.
int AddVPort (const ofp_vport_mod *ovpm)
 Add a virtual port to a switch device.
int StatsDump (ofi::StatsDumpCallback *cb_)
 Stats callback is ready for a dump.
void StatsDone (ofi::StatsDumpCallback *cb_)
 Stats callback is done.
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.
int ForwardControlInput (const void *msg, size_t length)
 The registered controller calls this method when sending a message to the switch.
sw_chain * GetChain ()
uint32_t GetNSwitchPorts (void) const
int GetSwitchPortIndex (ofi::Port p)
ofi::Port GetSwitchPort (uint32_t n) const
vport_table_t GetVPortTable ()
From NetDevice
virtual void SetIfIndex (const uint32_t index)
virtual uint32_t GetIfIndex (void) const
virtual Ptr< ChannelGetChannel (void) const
virtual void SetAddress (Address address)
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.
virtual bool IsPointToPoint (void) const
 Return true if the net device is on a point-to-point link.
virtual bool IsBridge (void) const
 Return true if the net device is acting as a bridge.
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< NodeGetNode (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.

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::NetDevice.
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 ()

Protected Member Functions

virtual void DoDispose (void)
void ReceiveFromDevice (Ptr< NetDevice > netdev, Ptr< const Packet > packet, uint16_t protocol, const Address &src, const Address &dst, PacketType packetType)
ofpbuf * BufferFromPacket (Ptr< Packet > packet, Address src, Address dst, int mtu, uint16_t protocol)

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


Member Function Documentation

virtual void ns3::OpenFlowSwitchNetDevice::AddLinkChangeCallback ( Callback< void >  callback) [virtual]
Parameters:
callbackthe 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.

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:
switchPortThe 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:
ovpmThe data for adding a virtual port.
Returns:
0 if everything's ok, otherwise an error number.
virtual void ns3::OpenFlowSwitchNetDevice::DoDispose ( void  ) [protected, virtual]

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_uidPacket UID; used to fetch the packet and its metadata.
in_portThe index of the port the Packet was initially received on.
max_lenThe 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_portThe port we want to output on.
ignore_no_fwdIf true, Ports that are set to not forward are forced to forward.
int ns3::OpenFlowSwitchNetDevice::ForwardControlInput ( const void *  msg,
size_t  length 
)

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

Parameters:
msgThe message received from the controller.
lengthLength 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.

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.

virtual uint32_t ns3::OpenFlowSwitchNetDevice::GetIfIndex ( void  ) const [virtual]
Returns:
index ifIndex of the device

Implements ns3::NetDevice.

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:
multicastGroupThe 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.

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

Parameters:
addrIPv6 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.

Returns:
Number of switch ports attached to this switch.
Parameters:
nindex of the Port.
Returns:
The Port.
Parameters:
pThe Port to get the index of.
Returns:
The index of the provided Port.
static TypeId ns3::OpenFlowSwitchNetDevice::GetTypeId ( void  ) [static]

This method returns the TypeId associated to ns3::NetDevice.

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::NetDevice.

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.

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.

virtual bool ns3::OpenFlowSwitchNetDevice::Send ( Ptr< Packet packet,
const Address dest,
uint16_t  protocolNumber 
) [virtual]
Parameters:
packetpacket sent from above down to Network Device
destmac address of the destination (already resolved)
protocolNumberidentifies 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.

virtual bool ns3::OpenFlowSwitchNetDevice::SendFrom ( Ptr< Packet packet,
const Address source,
const Address dest,
uint16_t  protocolNumber 
) [virtual]
Parameters:
packetpacket sent from above down to Network Device
sourcesource mac address (so called "MAC spoofing")
destmac address of the destination (already resolved)
protocolNumberidentifies 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.

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

Set the address of this interface

Parameters:
addressaddress to set

Implements ns3::NetDevice.

Set up the Switch's controller connection.

Parameters:
cPointer to a Controller.
virtual void ns3::OpenFlowSwitchNetDevice::SetIfIndex ( const uint32_t  index) [virtual]
Parameters:
indexifIndex of the device

Implements ns3::NetDevice.

virtual bool ns3::OpenFlowSwitchNetDevice::SetMtu ( const uint16_t  mtu) [virtual]
Parameters:
mtuMTU 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:
nodethe node associated to this netdevice.

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

Implements ns3::NetDevice.

Parameters:
cbcallback 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.

Parameters:
cbcallback to invoke whenever a packet has been received and must be forwarded to the higher layers.

Implements ns3::NetDevice.

Stats callback is done.

Controllers have a callback system for status requests which calls this function.

Parameters:
cb_The callback data.

Stats callback is ready for a dump.

Controllers have a callback system for status requests which calls this function.

Parameters:
cb_The callback data.
Returns:
0 if everything's ok, otherwise an error number.
virtual bool ns3::OpenFlowSwitchNetDevice::SupportsSendFrom ( ) const [virtual]
Returns:
true if this interface supports a bridging mode, false otherwise.

Implements ns3::NetDevice.


The documentation for this class was generated from the following file: