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)
void SetAddress (Mac48Address addr)
virtual void SetName (const std::string name)
virtual std::string GetName (void) const
virtual void SetIfIndex (const uint32_t index)
virtual uint32_t GetIfIndex (void) const
virtual Ptr< ChannelGetChannel (void) const
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 (void)
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)
void NotifyLinkUp (void)

Private Attributes

Ptr< Queuem_queue
TracedCallback< Ptr< const
Packet > > 
m_rxTrace
TracedCallback< Ptr< const
Packet > > 
m_dropTrace
Time m_tStart
Time m_tStop
EventId m_startEvent
EventId m_stopEvent
int32_t m_sock
Ptr< SystemThreadm_readThread
Ptr< Nodem_node
Mac48Address m_address
NetDevice::ReceiveCallback m_rxCallback
NetDevice::PromiscReceiveCallback m_promiscRxCallback
uint32_t m_ifIndex
int32_t m_sll_ifindex
std::string m_name
bool m_linkUp
Callback< void > m_linkChangeCallback
std::string m_deviceName

Detailed Description

A Device for an Emu Network Link.

Definition at line 44 of file emu-net-device.h.


Constructor & Destructor Documentation

ns3::EmuNetDevice::EmuNetDevice (  ) 

Construct a EmuNetDevice

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

Definition at line 98 of file emu-net-device.cc.

References m_tStart, NS_LOG_FUNCTION, and Start().

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

Destroy a EmuNetDevice

This is the destructor for the EmuNetDevice.

Definition at line 112 of file emu-net-device.cc.


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.

Definition at line 244 of file emu-net-device.cc.

References EMU_MAGIC, ns3::EmuBufferToString(), FindCreator(), m_sock, NS_ASSERT_MSG, NS_FATAL_ERROR, NS_LOG_DEBUG, NS_LOG_FUNCTION_NOARGS, and NS_LOG_INFO.

Referenced by StartDevice().

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.

Definition at line 117 of file emu-net-device.cc.

References m_node, and NS_LOG_FUNCTION_NOARGS.

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

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

Definition at line 453 of file emu-net-device.cc.

References NS_FATAL_ERROR.

Referenced by CreateSocket().

void ns3::EmuNetDevice::ForwardUp ( uint8_t *  buf,
uint32_t  len 
) [private]
Address ns3::EmuNetDevice::GetAddress ( void   )  const [virtual]
Returns:
the current Address of this interface.

Implements ns3::NetDevice.

Definition at line 784 of file emu-net-device.cc.

References m_address, and NS_LOG_FUNCTION_NOARGS.

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.

Definition at line 837 of file emu-net-device.cc.

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.

Implements ns3::NetDevice.

Definition at line 770 of file emu-net-device.cc.

References NS_FATAL_ERROR.

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

Implements ns3::NetDevice.

Definition at line 764 of file emu-net-device.cc.

References m_ifIndex.

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.

Definition at line 798 of file emu-net-device.cc.

References m_deviceName, and NS_FATAL_ERROR.

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.

Definition at line 866 of file emu-net-device.cc.

References GetMulticast(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

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.

Definition at line 849 of file emu-net-device.cc.

References NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by GetMulticast().

std::string ns3::EmuNetDevice::GetName ( void   )  const [virtual]
Returns:
name name of the device (e.g. "eth0")

Implements ns3::NetDevice.

Definition at line 752 of file emu-net-device.cc.

References m_name.

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.

Definition at line 903 of file emu-net-device.cc.

References m_node.

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.

Definition at line 729 of file emu-net-device.cc.

References m_queue, and NS_LOG_FUNCTION_NOARGS.

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]/$ns3EmuNetDevice

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:

  • Rx: Trace source indicating recvfrom of packet destined for broadcast, multicast or local address.

Reimplemented from ns3::NetDevice.

Definition at line 60 of file emu-net-device.cc.

References ns3::TypeId::AddAttribute(), ns3::TypeId::AddTraceSource(), m_address, m_deviceName, m_queue, m_rxTrace, m_tStart, m_tStop, ns3::MakeTraceSourceAccessor(), ns3::Seconds(), and ns3::TypeId::SetParent().

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

Is this a bridge?

Returns:
false.

Implements ns3::NetDevice.

Definition at line 883 of file emu-net-device.cc.

bool ns3::EmuNetDevice::IsBroadcast ( void   )  const [virtual]
Returns:
true if this interface supports a broadcast address, false otherwise.

Implements ns3::NetDevice.

Definition at line 831 of file emu-net-device.cc.

bool ns3::EmuNetDevice::IsLinkUp ( void   )  const [virtual]
Returns:
true if link is up; false otherwise

Implements ns3::NetDevice.

Definition at line 819 of file emu-net-device.cc.

References m_linkUp.

Referenced by SendFrom().

bool ns3::EmuNetDevice::IsMulticast ( void   )  const [virtual]
Returns:
value of m_isMulticast flag

Implements ns3::NetDevice.

Definition at line 843 of file emu-net-device.cc.

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

Is this a point to point link?

Returns:
false.

Implements ns3::NetDevice.

Definition at line 877 of file emu-net-device.cc.

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.

Definition at line 915 of file emu-net-device.cc.

void ns3::EmuNetDevice::NotifyLinkUp ( void   )  [private]
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

Definition at line 561 of file emu-net-device.cc.

References ForwardUp(), ns3::Simulator::GetImplementation(), m_sock, ns3::MakeEvent(), NS_FATAL_ERROR, NS_LOG_FUNCTION_NOARGS, NS_LOG_INFO, and NS_LOG_LOGIC.

Referenced by StartDevice().

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.

Definition at line 606 of file emu-net-device.cc.

References m_address, NS_LOG_FUNCTION, and SendFrom().

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.

Definition at line 632 of file emu-net-device.cc.

References ns3::EthernetTrailer::CalcFcs(), ns3::Mac48Address::ConvertFrom(), IsLinkUp(), m_deviceName, m_queue, m_sll_ifindex, m_sock, NS_FATAL_ERROR, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::EthernetHeader::SetDestination(), ns3::EthernetHeader::SetLengthType(), ns3::EthernetHeader::SetSource(), and ns3::LlcSnapHeader::SetType().

Referenced by Send().

void ns3::EmuNetDevice::SetAddress ( Mac48Address  addr  ) 

Assign a MAC address to this device.

See also:
Mac48Address
Parameters:
addr The new address.

Definition at line 777 of file emu-net-device.cc.

References m_address, and NS_LOG_FUNCTION.

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

Definition at line 715 of file emu-net-device.cc.

References NS_FATAL_ERROR, and NS_LOG_FUNCTION.

void ns3::EmuNetDevice::SetIfIndex ( const uint32_t  index  )  [virtual]
Parameters:
index ifIndex of the device

Implements ns3::NetDevice.

Definition at line 758 of file emu-net-device.cc.

References m_ifIndex.

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.

Definition at line 825 of file emu-net-device.cc.

References m_linkChangeCallback.

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.

Definition at line 791 of file emu-net-device.cc.

References NS_FATAL_ERROR.

void ns3::EmuNetDevice::SetName ( const std::string  name  )  [virtual]
Parameters:
name name of the device (e.g. "eth0")

Implements ns3::NetDevice.

Definition at line 746 of file emu-net-device.cc.

References m_name.

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.

Definition at line 909 of file emu-net-device.cc.

References m_node.

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.

Definition at line 889 of file emu-net-device.cc.

References NS_FATAL_ERROR.

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.

Definition at line 722 of file emu-net-device.cc.

References m_queue, and NS_LOG_FUNCTION.

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.

Definition at line 921 of file emu-net-device.cc.

References m_rxCallback.

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

Set a start time for the device.

Parameters:
tStart the start time

Definition at line 125 of file emu-net-device.cc.

References ns3::Simulator::Cancel(), m_startEvent, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and StartDevice().

Referenced by EmuNetDevice().

void ns3::EmuNetDevice::StartDevice ( void   )  [private]
void ns3::EmuNetDevice::Stop ( Time  tStop  ) 

Set a stop time for the device.

Parameters:
tStop the stop time

Definition at line 137 of file emu-net-device.cc.

References ns3::Simulator::Cancel(), m_startEvent, m_stopEvent, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and StopDevice().

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

Tear down the device

Definition at line 474 of file emu-net-device.cc.

References m_readThread, m_sock, NS_ASSERT_MSG, NS_LOG_FUNCTION_NOARGS, and NS_LOG_LOGIC.

Referenced by Stop().

bool ns3::EmuNetDevice::SupportsSendFrom ( void   )  const [virtual]
Returns:
true if this interface supports a bridging mode, false otherwise.

Implements ns3::NetDevice.

Definition at line 895 of file emu-net-device.cc.

References NS_LOG_FUNCTION_NOARGS.

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.

Definition at line 307 of file emu-net-device.h.

Referenced by ForwardUp(), GetAddress(), GetTypeId(), Send(), and SetAddress().

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

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

Definition at line 349 of file emu-net-device.h.

Referenced by GetMtu(), GetTypeId(), SendFrom(), and StartDevice().

The trace source for the packet drop events that the device can fire.

See also:
class CallBackTraceSource

Definition at line 280 of file emu-net-device.h.

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.

Definition at line 322 of file emu-net-device.h.

Referenced by GetIfIndex(), and SetIfIndex().

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

Definition at line 344 of file emu-net-device.h.

Referenced by NotifyLinkUp(), and SetLinkChangeCallback().

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

Definition at line 339 of file emu-net-device.h.

Referenced by IsLinkUp(), and NotifyLinkUp().

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

The human readable name of this device.

Definition at line 333 of file emu-net-device.h.

Referenced by GetName(), and SetName().

The Node to which this device is attached.

Definition at line 302 of file emu-net-device.h.

Referenced by DoDispose(), GetNode(), and SetNode().

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

Definition at line 317 of file emu-net-device.h.

Referenced by ForwardUp().

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

Definition at line 264 of file emu-net-device.h.

Referenced by GetQueue(), GetTypeId(), SendFrom(), and SetQueue().

Definition at line 297 of file emu-net-device.h.

Referenced by StartDevice(), and StopDevice().

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

Definition at line 312 of file emu-net-device.h.

Referenced by ForwardUp(), and SetReceiveCallback().

The trace source for the packet reception events that the device can fire.

See also:
class CallBackTraceSource

Definition at line 272 of file emu-net-device.h.

Referenced by ForwardUp(), and GetTypeId().

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.

Definition at line 328 of file emu-net-device.h.

Referenced by SendFrom(), and StartDevice().

int32_t ns3::EmuNetDevice::m_sock [private]

Definition at line 295 of file emu-net-device.h.

Referenced by CreateSocket(), ReadThread(), SendFrom(), StartDevice(), and StopDevice().

Definition at line 292 of file emu-net-device.h.

Referenced by Start(), and Stop().

Definition at line 293 of file emu-net-device.h.

Referenced by Stop().

Time to start spinning up the device

Definition at line 285 of file emu-net-device.h.

Referenced by EmuNetDevice(), and GetTypeId().

Time to start tearing down the device

Definition at line 290 of file emu-net-device.h.

Referenced by GetTypeId().


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:10:42 2009 for NS-3 by  doxygen 1.6.3