ns3::EmuNetDevice Class Reference

A Device for an Emu Network Link. More...

#include <emu-net-device.h>

Inheritance diagram for ns3::EmuNetDevice:

Inheritance graph
[legend]
Collaboration diagram for ns3::EmuNetDevice:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 EmuNetDevice ()
virtual ~EmuNetDevice ()
void SetDataRate (DataRate bps)
void Start (Time tStart)
void Stop (Time tStop)
void SetQueue (Ptr< Queue > queue)
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 SetLinkChangeCallback (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 Address GetMulticast (Ipv6Address addr) const
 Get the MAC multicast address corresponding to the IPv6 address provided.
virtual bool IsPointToPoint (void) const
virtual bool IsBridge (void) const
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 (PromiscReceiveCallback cb)
virtual bool SupportsSendFrom (void) const

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::EmuNetDevice.

Private Member Functions

virtual void DoDispose (void)
void CreateSocket (void)
std::string FindCreator (std::string creatorName)
Ptr< QueueGetQueue (void) const
void StartDevice (void)
void StopDevice (void)
void ReadThread (void)
void ForwardUp (uint8_t *buf, uint32_t len)
void AddHeader (Ptr< Packet > p, uint16_t protocolNumber)
bool ProcessHeader (Ptr< Packet > p, uint16_t &param)
bool TransmitStart (Ptr< Packet > p)

Private Attributes

Ptr< Queuem_queue
TracedCallback< Ptr< const
Packet > > 
m_macTxTrace
TracedCallback< Ptr< const
Packet > > 
m_macTxDropTrace
TracedCallback< Ptr< const
Packet > > 
m_macPromiscRxTrace
TracedCallback< Ptr< const
Packet > > 
m_macRxTrace
TracedCallback< Ptr< const
Packet > > 
m_macRxDropTrace
TracedCallback< Ptr< const
Packet > > 
m_phyTxBeginTrace
TracedCallback< Ptr< const
Packet > > 
m_phyTxEndTrace
TracedCallback< Ptr< const
Packet > > 
m_phyTxDropTrace
TracedCallback< Ptr< const
Packet > > 
m_phyRxTrace
TracedCallback< Ptr< const
Packet > > 
m_phyRxBeginTrace
TracedCallback< Ptr< const
Packet > > 
m_phyRxEndTrace
TracedCallback< Ptr< const
Packet > > 
m_phyRxDropTrace
TracedCallback< Ptr< const
Packet > > 
m_snifferTrace
TracedCallback< Ptr< const
Packet > > 
m_promiscSnifferTrace
Time m_tStart
Time m_tStop
Ptr< Nodem_node
Mac48Address m_address
NetDevice::ReceiveCallback m_rxCallback
NetDevice::PromiscReceiveCallback m_promiscRxCallback
uint32_t m_ifIndex
int32_t m_sll_ifindex
bool m_linkUp
bool m_isBroadcast
bool m_isMulticast
Callback< void > m_linkChangeCallback
std::string m_deviceName


Detailed Description

A Device for an Emu Network Link.

Constructor & Destructor Documentation

ns3::EmuNetDevice::EmuNetDevice (  ) 

Construct a EmuNetDevice

This is the constructor for the EmuNetDevice. It takes as a

virtual ns3::EmuNetDevice::~EmuNetDevice (  )  [virtual]

Destroy a EmuNetDevice

This is the destructor for the EmuNetDevice.


Member Function Documentation

void ns3::EmuNetDevice::AddHeader ( Ptr< Packet p,
uint16_t  protocolNumber 
) [private]

Adds the necessary headers and trailers to a packet of data in order to respect the protocol implemented by the agent.

void ns3::EmuNetDevice::CreateSocket ( void   )  [private]

Call out to a separate process running as suid root in order to get a raw socket. We do this to avoid having the entire simulation running as root. If this method returns, we'll have a raw socket waiting for us in m_sock.

virtual void ns3::EmuNetDevice::DoDispose ( void   )  [private, 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.

Reimplemented from ns3::Object.

std::string ns3::EmuNetDevice::FindCreator ( std::string  creatorName  )  [private]

Figure out where the raw socket creation process lives on the system.

void ns3::EmuNetDevice::ForwardUp ( uint8_t *  buf,
uint32_t  len 
) [private]

Method to handle received packets. Synchronized with simulator via ScheduleNow from ReadThread.

virtual Address ns3::EmuNetDevice::GetAddress ( void   )  const [virtual]

Returns:
the current Address of this interface.

Implements ns3::NetDevice.

virtual Address ns3::EmuNetDevice::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.

virtual Ptr<Channel> ns3::EmuNetDevice::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::EmuNetDevice::GetIfIndex ( void   )  const [virtual]

Returns:
index ifIndex of the device

Implements ns3::NetDevice.

virtual uint16_t ns3::EmuNetDevice::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::EmuNetDevice::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 Address ns3::EmuNetDevice::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).

This method performs the multicast address creation function appropriate to an EUI-48-based CSMA device. This MAC address is encapsulated in an abstract Address to avoid dependencies on the exact address format.

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.
See also:
Ipv4Address

Mac48Address

Address

Implements ns3::NetDevice.

virtual Ptr<Node> ns3::EmuNetDevice::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.

Ptr<Queue> ns3::EmuNetDevice::GetQueue ( void   )  const [private]

Get a copy of the attached Queue.

This method is provided for any derived class that may need to get direct access to the underlying queue.

Returns:
Ptr to the queue.

static TypeId ns3::EmuNetDevice::GetTypeId ( void   )  [static]

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

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

  • /NodeList/[i]/DeviceList/[i]/$ns3::EmuNetDevice
Attributes defined for this type:
  • Address: The ns-3 MAC address of this (virtual) device.
  • DeviceName: The name of the underlying real device (e.g. eth1).
    • Set with class: StringValue
    • Underlying type: std::string
    • Initial value: eth1
    • Flags: construct write read
  • Start: The simulation time at which to spin up the device thread.
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: 0ns
    • Flags: construct write read
  • Stop: The simulation time at which to tear down the device thread.
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: 0ns
    • Flags: construct write read
  • TxQueue: A queue to use as the transmit queue in the device.
Attributes defined in parent class ns3::NetDevice:
  • Mtu: The MAC-level Maximum Transmission Unit
TraceSources defined for this type:
  • MacTx: Trace source indicating a packet has arrived for transmission by this device
  • MacTxDrop: Trace source indicating a packet has been dropped by the device before transmission
  • MacPromiscRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a promiscuous trace,
  • MacRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a non-promiscuous trace,
  • Sniffer: Trace source simulating a non-promiscuous packet sniffer attached to the device
  • PromiscSniffer: Trace source simulating a promiscuous packet sniffer attached to the device

Reimplemented from ns3::NetDevice.

virtual bool ns3::EmuNetDevice::IsBridge ( void   )  const [virtual]

Is this a bridge?

Returns:
false.

Implements ns3::NetDevice.

virtual bool ns3::EmuNetDevice::IsBroadcast ( void   )  const [virtual]

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

Implements ns3::NetDevice.

virtual bool ns3::EmuNetDevice::IsLinkUp ( void   )  const [virtual]

Returns:
true if link is up; false otherwise

Implements ns3::NetDevice.

virtual bool ns3::EmuNetDevice::IsMulticast ( void   )  const [virtual]

Returns:
value of m_isMulticast flag

Implements ns3::NetDevice.

virtual bool ns3::EmuNetDevice::IsPointToPoint ( void   )  const [virtual]

Is this a point to point link?

Returns:
false.

Implements ns3::NetDevice.

virtual bool ns3::EmuNetDevice::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.

bool ns3::EmuNetDevice::ProcessHeader ( Ptr< Packet p,
uint16_t &  param 
) [private]

Removes, from a packet of data, all headers and trailers that relate to the protocol implemented by the agent

Returns:
Returns true if the packet should be forwarded up the protocol stack.

void ns3::EmuNetDevice::ReadThread ( void   )  [private]

Loop to read and process packets

virtual bool ns3::EmuNetDevice::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.

virtual bool ns3::EmuNetDevice::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.

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

Set the address of this interface

Implements ns3::NetDevice.

void ns3::EmuNetDevice::SetDataRate ( DataRate  bps  ) 

Set the Data Rate used for transmission of packets.

See also:
Attach ()
Parameters:
bps the data rate at which this object operates

virtual void ns3::EmuNetDevice::SetIfIndex ( const uint32_t  index  )  [virtual]

Parameters:
index ifIndex of the device

Implements ns3::NetDevice.

virtual void ns3::EmuNetDevice::SetLinkChangeCallback ( Callback< void >  callback  )  [virtual]

Parameters:
callback the callback to invoke
Register 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 whenever the link goes up.

Implements ns3::NetDevice.

virtual bool ns3::EmuNetDevice::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::EmuNetDevice::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::EmuNetDevice::SetPromiscReceiveCallback ( 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.

void ns3::EmuNetDevice::SetQueue ( Ptr< Queue queue  ) 

Attach a queue to the EmuNetDevice.

The EmuNetDevice "owns" a queue that implements a queueing method such as DropTail or RED.

See also:
Queue

DropTailQueue

Parameters:
queue Ptr to the new queue.

virtual void ns3::EmuNetDevice::SetReceiveCallback ( NetDevice::ReceiveCallback  cb  )  [virtual]

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

Implements ns3::NetDevice.

void ns3::EmuNetDevice::Start ( Time  tStart  ) 

Set a start time for the device.

Parameters:
tStart the start time

void ns3::EmuNetDevice::StartDevice ( void   )  [private]

Spin up the device

void ns3::EmuNetDevice::Stop ( Time  tStop  ) 

Set a stop time for the device.

Parameters:
tStop the stop time

void ns3::EmuNetDevice::StopDevice ( void   )  [private]

Tear down the device

virtual bool ns3::EmuNetDevice::SupportsSendFrom ( void   )  const [virtual]

Returns:
true if this interface supports a bridging mode, false otherwise.

Implements ns3::NetDevice.

bool ns3::EmuNetDevice::TransmitStart ( Ptr< Packet p  )  [private]

Start Sending a Packet Down the Wire.

Returns:
true if success, false on failure


Member Data Documentation

The MAC address which has been assigned to this device.

std::string ns3::EmuNetDevice::m_deviceName [private]

The unix/linux name of the underlying device (e.g., eth0)

uint32_t ns3::EmuNetDevice::m_ifIndex [private]

The ns-3 interface index (in the sense of net device index) that has been assigned to this network device.

Flag indicating whether or not the underlying net device supports broadcast.

Flag indicating whether or not the underlying net device supports multicast.

Callback to fire if the link changes state (up or down).

Flag indicating whether or not the link is up. In this case, whether or not the device is connected to a channel.

The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition). This is a promiscuous trace.

See also:
class CallBackTraceSource

The trace source fired for packets successfully received by the device but which are dropped before being forwarded up to higher layers (at the L2/L3 transition).

See also:
class CallBackTraceSource

The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition). This is a non-promiscuous trace.

See also:
class CallBackTraceSource

The trace source fired when packets coming into the "top" of the device at the L3/L2 transition are dropped before being queued for transmission.

See also:
class CallBackTraceSource

The trace source fired when packets come into the "top" of the device at the L3/L2 transition, before being queued for transmission.

See also:
class CallBackTraceSource

The Node to which this device is attached.

The trace source fired when a packet begins the reception process from the medium.

See also:
class CallBackTraceSource

The trace source fired when the phy layer drops a packet it has received.

See also:
class CallBackTraceSource

The trace source fired when a packet begins the reception process from the medium.

See also:
class CallBackTraceSource

The trace source fired when a packet ends the reception process from the medium.

See also:
class CallBackTraceSource

The trace source fired when a packet begins the transmission process on the medium.

See also:
class CallBackTraceSource

The trace source fired when the phy layer drops a packet as it tries to transmit it.

See also:
class CallBackTraceSource

The trace source fired when a packet ends the transmission process on the medium.

See also:
class CallBackTraceSource

The callback used to notify higher layers that a packet has been received in promiscuous mode.

A trace source that emulates a promiscuous mode protocol sniffer connected to the device. This trace source fire on packets destined for any host just like your average everyday packet sniffer.

On the transmit size, this trace hook will fire after a packet is dequeued from the device queue for transmission. In Linux, for example, this would correspond to the point just before a device hard_start_xmit where dev_queue_xmit_nit is called to dispatch the packet to the PF_PACKET ETH_P_ALL handlers.

On the receive side, this trace hook will fire when a packet is received, just before the receive callback is executed. In Linux, for example, this would correspond to the point at which the packet is dispatched to packet sniffers in netif_receive_skb.

See also:
class CallBackTraceSource

The Queue which this EmuNetDevice uses as a packet source. Management of this Queue has been delegated to the EmuNetDevice and it has the responsibility for deletion.

See also:
class Queue

class DropTailQueue

The callback used to notify higher layers that a packet has been received.

The Unix interface index that we got from the system and which corresponds to the interface (e.g., "eth1") we are using to talk to the network. Valid when m_sock is valid.

A trace source that emulates a non-promiscuous protocol sniffer connected to the device. Unlike your average everyday sniffer, this trace source will not fire on PACKET_OTHERHOST events.

On the transmit size, this trace hook will fire after a packet is dequeued from the device queue for transmission. In Linux, for example, this would correspond to the point just before a device hard_start_xmit where dev_queue_xmit_nit is called to dispatch the packet to the PF_PACKET ETH_P_ALL handlers.

On the receive side, this trace hook will fire when a packet is received, just before the receive callback is executed. In Linux, for example, this would correspond to the point at which the packet is dispatched to packet sniffers in netif_receive_skb.

See also:
class CallBackTraceSource

Time to start spinning up the device

Time to start tearing down the device


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

Generated on Fri Apr 9 15:01:09 2010 for NS-3 by  doxygen 1.5.8