#include <emu-net-device.h>
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< Channel > | GetChannel (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< Node > | GetNode (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< Queue > | GetQueue (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 ¶m) |
bool | TransmitStart (Ptr< Packet > p) |
Private Attributes | |
Ptr< Queue > | m_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< Node > | m_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 |
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.
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] |
virtual Address ns3::EmuNetDevice::GetBroadcast | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
Implements ns3::NetDevice.
virtual uint32_t ns3::EmuNetDevice::GetIfIndex | ( | void | ) | const [virtual] |
virtual uint16_t ns3::EmuNetDevice::GetMtu | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
virtual Address ns3::EmuNetDevice::GetMulticast | ( | Ipv6Address | addr | ) | const [virtual] |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
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.
multicastGroup | The IP address for the multicast group destination of the packet. |
Implements ns3::NetDevice.
Implements ns3::NetDevice.
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:
Reimplemented from ns3::NetDevice.
virtual bool ns3::EmuNetDevice::IsBridge | ( | void | ) | const [virtual] |
virtual bool ns3::EmuNetDevice::IsBroadcast | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
virtual bool ns3::EmuNetDevice::IsLinkUp | ( | void | ) | const [virtual] |
virtual bool ns3::EmuNetDevice::IsMulticast | ( | void | ) | const [virtual] |
virtual bool ns3::EmuNetDevice::IsPointToPoint | ( | void | ) | const [virtual] |
virtual bool ns3::EmuNetDevice::NeedsArp | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
Removes, from a packet of data, all headers and trailers that relate to the protocol implemented by the agent
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] |
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. |
Implements ns3::NetDevice.
virtual bool ns3::EmuNetDevice::SendFrom | ( | Ptr< Packet > | packet, | |
const Address & | source, | |||
const Address & | dest, | |||
uint16_t | protocolNumber | |||
) | [virtual] |
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. |
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.
bps | the data rate at which this object operates |
virtual void ns3::EmuNetDevice::SetIfIndex | ( | const uint32_t | index | ) | [virtual] |
virtual void ns3::EmuNetDevice::SetLinkChangeCallback | ( | Callback< void > | callback | ) | [virtual] |
callback | the callback to invoke |
Implements ns3::NetDevice.
virtual bool ns3::EmuNetDevice::SetMtu | ( | const uint16_t | mtu | ) | [virtual] |
mtu | MTU value, in bytes, to set for the device |
Implements ns3::NetDevice.
node | the node associated to this netdevice. |
Implements ns3::NetDevice.
virtual void ns3::EmuNetDevice::SetPromiscReceiveCallback | ( | PromiscReceiveCallback | cb | ) | [virtual] |
cb | callback to invoke whenever a packet has been received in promiscuous mode and must be forwarded to the higher layers. |
Implements ns3::NetDevice.
Attach a queue to the EmuNetDevice.
The EmuNetDevice "owns" a queue that implements a queueing method such as DropTail or RED.
queue | Ptr to the new queue. |
virtual void ns3::EmuNetDevice::SetReceiveCallback | ( | NetDevice::ReceiveCallback | cb | ) | [virtual] |
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.
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.
tStop | the stop time |
void ns3::EmuNetDevice::StopDevice | ( | void | ) | [private] |
Tear down the device
virtual bool ns3::EmuNetDevice::SupportsSendFrom | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
Mac48Address ns3::EmuNetDevice::m_address [private] |
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.
bool ns3::EmuNetDevice::m_isBroadcast [private] |
Flag indicating whether or not the underlying net device supports broadcast.
bool ns3::EmuNetDevice::m_isMulticast [private] |
Flag indicating whether or not the underlying net device supports multicast.
Callback<void> ns3::EmuNetDevice::m_linkChangeCallback [private] |
Callback to fire if the link changes state (up or down).
bool ns3::EmuNetDevice::m_linkUp [private] |
Flag indicating whether or not the link is up. In this case, whether or not the device is connected to a channel.
TracedCallback<Ptr<const Packet> > ns3::EmuNetDevice::m_macPromiscRxTrace [private] |
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.
TracedCallback<Ptr<const Packet> > ns3::EmuNetDevice::m_macRxDropTrace [private] |
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).
TracedCallback<Ptr<const Packet> > ns3::EmuNetDevice::m_macRxTrace [private] |
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.
TracedCallback<Ptr<const Packet> > ns3::EmuNetDevice::m_macTxDropTrace [private] |
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.
TracedCallback<Ptr<const Packet> > ns3::EmuNetDevice::m_macTxTrace [private] |
The trace source fired when packets come into the "top" of the device at the L3/L2 transition, before being queued for transmission.
Ptr<Node> ns3::EmuNetDevice::m_node [private] |
The Node to which this device is attached.
TracedCallback<Ptr<const Packet> > ns3::EmuNetDevice::m_phyRxBeginTrace [private] |
The trace source fired when a packet begins the reception process from the medium.
TracedCallback<Ptr<const Packet> > ns3::EmuNetDevice::m_phyRxDropTrace [private] |
The trace source fired when the phy layer drops a packet it has received.
TracedCallback<Ptr<const Packet> > ns3::EmuNetDevice::m_phyRxEndTrace [private] |
The trace source fired when a packet begins the reception process from the medium.
TracedCallback<Ptr<const Packet> > ns3::EmuNetDevice::m_phyRxTrace [private] |
The trace source fired when a packet ends the reception process from the medium.
TracedCallback<Ptr<const Packet> > ns3::EmuNetDevice::m_phyTxBeginTrace [private] |
The trace source fired when a packet begins the transmission process on the medium.
TracedCallback<Ptr<const Packet> > ns3::EmuNetDevice::m_phyTxDropTrace [private] |
The trace source fired when the phy layer drops a packet as it tries to transmit it.
TracedCallback<Ptr<const Packet> > ns3::EmuNetDevice::m_phyTxEndTrace [private] |
The trace source fired when a packet ends the transmission process on the medium.
The callback used to notify higher layers that a packet has been received in promiscuous mode.
TracedCallback<Ptr<const Packet> > ns3::EmuNetDevice::m_promiscSnifferTrace [private] |
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.
Ptr<Queue> ns3::EmuNetDevice::m_queue [private] |
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.
class DropTailQueue
The callback used to notify higher layers that a packet has been received.
int32_t ns3::EmuNetDevice::m_sll_ifindex [private] |
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.
TracedCallback<Ptr<const Packet> > ns3::EmuNetDevice::m_snifferTrace [private] |
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.
Time ns3::EmuNetDevice::m_tStart [private] |
Time to start spinning up the device
Time ns3::EmuNetDevice::m_tStop [private] |
Time to start tearing down the device