A Discrete-Event Network Simulator
API
ns3::FdNetDevice Class Reference

a NetDevice to read/write network traffic from/into a file descriptor. More...

#include "fd-net-device.h"

+ Inheritance diagram for ns3::FdNetDevice:
+ Collaboration diagram for ns3::FdNetDevice:

Public Types

enum  EncapsulationMode { DIX, LLC, DIXPI }
 Enumeration of the types of frames supported in the class. More...
 
- Public Types inherited from ns3::NetDevice
typedef void(* LinkChangeTracedCallback) (void)
 TracedCallback signature for link changed event. More...
 
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 PacketTypePromiscReceiveCallback
 
typedef Callback< bool, Ptr< NetDevice >, Ptr< const Packet >, uint16_t, const Address &> ReceiveCallback
 

Public Member Functions

 FdNetDevice ()
 Constructor for the FdNetDevice. More...
 
virtual ~FdNetDevice ()
 Destructor for the FdNetDevice. More...
 
virtual void AddLinkChangeCallback (Callback< void > callback)
 
virtual Address GetAddress (void) const
 
virtual Address GetBroadcast (void) const
 
virtual Ptr< ChannelGetChannel (void) const
 
FdNetDevice::EncapsulationMode GetEncapsulationMode (void) const
 Get the link layer encapsulation mode of this device. More...
 
virtual uint32_t GetIfIndex (void) const
 
virtual uint16_t GetMtu (void) const
 
virtual Address GetMulticast (Ipv4Address multicastGroup) const
 Make and return a MAC multicast address using the provided multicast group. More...
 
virtual Address GetMulticast (Ipv6Address addr) const
 Get the MAC multicast address corresponding to the IPv6 address provided. More...
 
virtual Ptr< NodeGetNode (void) const
 
virtual bool IsBridge (void) const
 Return true if the net device is acting as a bridge. More...
 
virtual bool IsBroadcast (void) const
 
virtual bool IsLinkUp (void) const
 
virtual bool IsMulticast (void) const
 
virtual bool IsPointToPoint (void) const
 Return true if the net device is on a point-to-point link. More...
 
virtual bool NeedsArp (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 void SetAddress (Address address)
 Set the address of this interface. More...
 
void SetEncapsulationMode (FdNetDevice::EncapsulationMode mode)
 Set the link layer encapsulation mode of this device. More...
 
void SetFileDescriptor (int fd)
 Set the associated file descriptor. More...
 
virtual void SetIfIndex (const uint32_t index)
 
virtual void SetIsBroadcast (bool broadcast)
 Set if the NetDevice is able to send Broadcast messages. More...
 
virtual void SetIsMulticast (bool multicast)
 Set if the NetDevice is able to send Multicast messages. More...
 
virtual bool SetMtu (const uint16_t mtu)
 
virtual void SetNode (Ptr< Node > node)
 
virtual void SetPromiscReceiveCallback (NetDevice::PromiscReceiveCallback cb)
 
virtual void SetReceiveCallback (NetDevice::ReceiveCallback cb)
 
void Start (Time tStart)
 Set a start time for the device. More...
 
void Stop (Time tStop)
 Set a stop time for the device. More...
 
virtual bool SupportsSendFrom () const
 
virtual ssize_t Write (uint8_t *buffer, size_t length)
 Write packet data to device. More...
 
- Public Member Functions inherited from ns3::NetDevice
virtual ~NetDevice ()
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. 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
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

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

Protected Member Functions

virtual uint8_t * AllocateBuffer (size_t len)
 Allocate packet buffer. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Method Initialization for start and stop attributes. More...
 
virtual void FreeBuffer (uint8_t *buf)
 Free the given packet buffer. More...
 
int GetFileDescriptor (void) const
 Get the associated file descriptor. More...
 
void ReceiveCallback (uint8_t *buf, ssize_t len)
 Callback to invoke when a new frame is received. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Protected Attributes

std::queue< std::pair< uint8_t *, ssize_t > > m_pendingQueue
 Number of packets that were received and scheduled for read but not yet read. More...
 
SystemMutex m_pendingReadMutex
 Mutex to increase pending read counter. More...
 

Private Member Functions

 FdNetDevice (FdNetDevice const &)
 Copy constructor. More...
 
virtual Ptr< FdReaderDoCreateFdReader (void)
 Create the FdReader object. More...
 
virtual void DoFinishStartingDevice (void)
 Complete additional actions, if any, to spin up down the device. More...
 
virtual void DoFinishStoppingDevice (void)
 Complete additional actions, if any, to tear down the device. More...
 
void ForwardUp (void)
 Forward the frame to the appropriate callback for processing. More...
 
void NotifyLinkUp (void)
 Notify that the link is up and ready. More...
 
void StartDevice (void)
 Spin up the device. More...
 
void StopDevice (void)
 Tear down the device. More...
 
bool TransmitStart (Ptr< Packet > p)
 Start Sending a Packet Down the Wire. More...
 

Private Attributes

Mac48Address m_address
 The net device mac address. More...
 
EncapsulationMode m_encapMode
 The type of encapsulation of the received/transmitted frames. More...
 
int m_fd
 The file descriptor used for receive/send network traffic. More...
 
Ptr< FdReaderm_fdReader
 Reader for the file descriptor. More...
 
uint32_t m_ifIndex
 The ns-3 interface index (in the sense of net device index) that has been assigned to this network device. More...
 
bool m_isBroadcast
 Flag indicating whether or not the underlying net device supports broadcast. More...
 
bool m_isMulticast
 Flag indicating whether or not the underlying net device supports multicast. More...
 
TracedCallback m_linkChangeCallbacks
 Callbacks to fire if the link changes state (up or down). More...
 
bool m_linkUp
 Flag indicating whether or not the link is up. More...
 
TracedCallback< Ptr< const Packet > > m_macPromiscRxTrace
 The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition). More...
 
TracedCallback< Ptr< const Packet > > m_macRxDropTrace
 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). More...
 
TracedCallback< Ptr< const Packet > > m_macRxTrace
 The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition). More...
 
TracedCallback< Ptr< const Packet > > m_macTxDropTrace
 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. More...
 
TracedCallback< Ptr< const Packet > > m_macTxTrace
 The trace source fired when packets come into the "top" of the device at the L3/L2 transition, before being queued for transmission. More...
 
uint32_t m_maxPendingReads
 Maximum number of packets that can be received and scheduled for read but not yet read. More...
 
uint16_t m_mtu
 The MTU associated to the file descriptor technology. More...
 
Ptr< Nodem_node
 The ns-3 node associated to the net device. More...
 
uint32_t m_nodeId
 a copy of the node id so the read thread doesn't have to GetNode() in in order to find the node ID. More...
 
TracedCallback< Ptr< const Packet > > m_phyRxDropTrace
 The trace source fired when the phy layer drops a packet it has received. More...
 
TracedCallback< Ptr< const Packet > > m_phyTxDropTrace
 The trace source fired when the phy layer drops a packet as it tries to transmit it. More...
 
NetDevice::PromiscReceiveCallback m_promiscRxCallback
 The callback used to notify higher layers that a packet has been received in promiscuous mode. More...
 
TracedCallback< Ptr< const Packet > > m_promiscSnifferTrace
 A trace source that emulates a promiscuous mode protocol sniffer connected to the device. More...
 
NetDevice::ReceiveCallback m_rxCallback
 The callback used to notify higher layers that a packet has been received. More...
 
TracedCallback< Ptr< const Packet > > m_snifferTrace
 A trace source that emulates a non-promiscuous protocol sniffer connected to the device. More...
 
EventId m_startEvent
 NetDevice start event. More...
 
EventId m_stopEvent
 NetDevice stop event. More...
 
Time m_tStart
 Time to start spinning up the device. More...
 
Time m_tStop
 Time to start tearing down the device. More...
 

Additional Inherited Members

Detailed Description

a NetDevice to read/write network traffic from/into a file descriptor.


A FdNetDevice object will read and write frames/packets from/to a file descriptor. This file descriptor might be associated to a Linux TAP/TUN device, to a socket or to a user space process, allowing the simulation to exchange traffic with the "outside-world"

Config Paths

ns3::FdNetDevice is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/DeviceList/[i]/$ns3::FdNetDevice"

Attributes

  • Address: The MAC address of this device.
  • Start: The simulation time at which to spin up the device thread.
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +0ns
    • Flags: construct write read
  • Stop: The simulation time at which to tear down the device thread.
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +0ns
    • Flags: construct write read
  • EncapsulationMode: The link-layer encapsulation type to use.
    • Set with class: ns3::EnumValue
    • Underlying type:
    • Initial value: Dix
    • Flags: construct write read
  • RxQueueSize: Maximum size of the read queue. This value limits number of packets that have been read from the network into a memory buffer but have not yet been processed by the simulator.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 1000
    • Flags: construct write read

TraceSources

  • MacTx: Trace source indicating a packet has arrived for transmission by this device
    Callback signature: ns3::Packet::TracedCallback
  • MacTxDrop: Trace source indicating a packet has been dropped by the device before transmission
    Callback signature: ns3::Packet::TracedCallback
  • 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,
    Callback signature: ns3::Packet::TracedCallback
  • 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,
    Callback signature: ns3::Packet::TracedCallback
  • Sniffer: Trace source simulating a non-promiscuous packet sniffer attached to the device
    Callback signature: ns3::Packet::TracedCallback
  • PromiscSniffer: Trace source simulating a promiscuous packet sniffer attached to the device
    Callback signature: ns3::Packet::TracedCallback

Size of this type is 416 bytes (on a 64-bit architecture).

Definition at line 84 of file fd-net-device.h.

Member Enumeration Documentation

◆ EncapsulationMode

Enumeration of the types of frames supported in the class.

Enumerator
DIX 

DIX II / Ethernet II packet.

LLC 

802.2 LLC/SNAP Packet

DIXPI 

When using TAP devices, if flag IFF_NO_PI is not set on the device, IP packets will have an extra header: Flags [2 bytes] Proto [2 bytes] Raw protocol(IP, IPv6, etc) frame.

Definition at line 96 of file fd-net-device.h.

Constructor & Destructor Documentation

◆ FdNetDevice() [1/2]

ns3::FdNetDevice::FdNetDevice ( )

Constructor for the FdNetDevice.

Definition at line 168 of file fd-net-device.cc.

References NS_LOG_FUNCTION.

◆ ~FdNetDevice()

ns3::FdNetDevice::~FdNetDevice ( )
virtual

Destructor for the FdNetDevice.

Definition at line 183 of file fd-net-device.cc.

References NS_LOG_FUNCTION.

◆ FdNetDevice() [2/2]

ns3::FdNetDevice::FdNetDevice ( FdNetDevice const &  )
private

Copy constructor.

Defined and unimplemented to avoid misuse as suggested in http://www.nsnam.org/wiki/NS-3_Python_Bindings#.22invalid_use_of_incomplete_type.22

Member Function Documentation

◆ AddLinkChangeCallback()

void ns3::FdNetDevice::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.

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

References ns3::TracedCallback< Ts >::ConnectWithoutContext(), and m_linkChangeCallbacks.

+ Here is the call graph for this function:

◆ AllocateBuffer()

uint8_t * ns3::FdNetDevice::AllocateBuffer ( size_t  len)
protectedvirtual

Allocate packet buffer.

Reimplemented in ns3::DpdkNetDevice.

Definition at line 399 of file fd-net-device.cc.

Referenced by SendFrom().

+ Here is the caller graph for this function:

◆ DoCreateFdReader()

Ptr< FdReader > ns3::FdNetDevice::DoCreateFdReader ( void  )
privatevirtual

Create the FdReader object.

Returns
the created FdReader object

Reimplemented in ns3::NetmapNetDevice.

Definition at line 260 of file fd-net-device.cc.

References m_mtu, and NS_LOG_FUNCTION.

Referenced by StartDevice().

+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::FdNetDevice::DoDispose ( void  )
protectedvirtual

Destructor implementation.

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

Subclasses are expected to implement their real destruction code in an overridden 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.

Definition at line 202 of file fd-net-device.cc.

References ns3::Object::DoDispose(), NS_LOG_FUNCTION, and StopDevice().

+ Here is the call graph for this function:

◆ DoFinishStartingDevice()

void ns3::FdNetDevice::DoFinishStartingDevice ( void  )
privatevirtual

Complete additional actions, if any, to spin up down the device.

Reimplemented in ns3::NetmapNetDevice.

Definition at line 271 of file fd-net-device.cc.

References NS_LOG_FUNCTION.

Referenced by StartDevice().

+ Here is the caller graph for this function:

◆ DoFinishStoppingDevice()

void ns3::FdNetDevice::DoFinishStoppingDevice ( void  )
privatevirtual

Complete additional actions, if any, to tear down the device.

Reimplemented in ns3::NetmapNetDevice, and ns3::DpdkNetDevice.

Definition at line 277 of file fd-net-device.cc.

References NS_LOG_FUNCTION.

Referenced by StopDevice().

+ Here is the caller graph for this function:

◆ DoInitialize()

void ns3::FdNetDevice::DoInitialize ( void  )
protectedvirtual

Method Initialization for start and stop attributes.

Reimplemented from ns3::Object.

Definition at line 189 of file fd-net-device.cc.

References ns3::Object::DoInitialize(), m_tStart, m_tStop, NS_LOG_FUNCTION, ns3::Seconds(), Start(), and Stop().

+ Here is the call graph for this function:

◆ ForwardUp()

◆ FreeBuffer()

void ns3::FdNetDevice::FreeBuffer ( uint8_t *  buf)
protectedvirtual

Free the given packet buffer.

Reimplemented in ns3::DpdkNetDevice.

Definition at line 405 of file fd-net-device.cc.

Referenced by ForwardUp(), and SendFrom().

+ Here is the caller graph for this function:

◆ GetAddress()

Address ns3::FdNetDevice::GetAddress ( void  ) const
virtual
Returns
the current Address of this interface.

Implements ns3::NetDevice.

Definition at line 666 of file fd-net-device.cc.

References m_address.

◆ GetBroadcast()

Address ns3::FdNetDevice::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 740 of file fd-net-device.cc.

◆ GetChannel()

Ptr< Channel > ns3::FdNetDevice::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.

Definition at line 691 of file fd-net-device.cc.

◆ GetEncapsulationMode()

FdNetDevice::EncapsulationMode ns3::FdNetDevice::GetEncapsulationMode ( void  ) const

Get the link layer encapsulation mode of this device.

Returns
The link layer encapsulation mode of this device.

Definition at line 218 of file fd-net-device.cc.

References m_encapMode, and NS_LOG_FUNCTION.

◆ GetFileDescriptor()

int ns3::FdNetDevice::GetFileDescriptor ( void  ) const
protected

Get the associated file descriptor.

Returns
the associated file descriptor

Definition at line 654 of file fd-net-device.cc.

References m_fd.

Referenced by ns3::NetmapNetDevice::SyncAndNotifyQueue().

+ Here is the caller graph for this function:

◆ GetIfIndex()

uint32_t ns3::FdNetDevice::GetIfIndex ( void  ) const
virtual
Returns
index ifIndex of the device

Implements ns3::NetDevice.

Definition at line 685 of file fd-net-device.cc.

References m_ifIndex.

◆ GetMtu()

uint16_t ns3::FdNetDevice::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 710 of file fd-net-device.cc.

References m_mtu.

Referenced by ns3::NetmapNetDevice::DoCreateFdReader().

+ Here is the caller graph for this function:

◆ GetMulticast() [1/2]

Address ns3::FdNetDevice::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
IsMulticast()

Implements ns3::NetDevice.

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

References ns3::Mac48Address::GetMulticast().

+ Here is the call graph for this function:

◆ GetMulticast() [2/2]

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

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.

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

References ns3::Mac48Address::GetMulticast().

+ Here is the call graph for this function:

◆ GetNode()

Ptr< Node > ns3::FdNetDevice::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 782 of file fd-net-device.cc.

References m_node.

◆ GetTypeId()

◆ IsBridge()

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

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

Returns
value of m_isBridge flag

Implements ns3::NetDevice.

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

◆ IsBroadcast()

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

Implements ns3::NetDevice.

Definition at line 728 of file fd-net-device.cc.

References m_isBroadcast.

◆ IsLinkUp()

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

Implements ns3::NetDevice.

Reimplemented in ns3::DpdkNetDevice.

Definition at line 716 of file fd-net-device.cc.

References m_linkUp.

Referenced by SendFrom().

+ Here is the caller graph for this function:

◆ IsMulticast()

bool ns3::FdNetDevice::IsMulticast ( void  ) const
virtual
Returns
value of m_isMulticast flag

Implements ns3::NetDevice.

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

References m_isMulticast.

◆ IsPointToPoint()

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

Definition at line 776 of file fd-net-device.cc.

◆ NeedsArp()

bool ns3::FdNetDevice::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 799 of file fd-net-device.cc.

◆ NotifyLinkUp()

void ns3::FdNetDevice::NotifyLinkUp ( void  )
private

Notify that the link is up and ready.

Definition at line 672 of file fd-net-device.cc.

References m_linkChangeCallbacks, and m_linkUp.

Referenced by StartDevice().

+ Here is the caller graph for this function:

◆ ReceiveCallback()

void ns3::FdNetDevice::ReceiveCallback ( uint8_t *  buf,
ssize_t  len 
)
protected

Callback to invoke when a new frame is received.

Definition at line 303 of file fd-net-device.cc.

References ForwardUp(), m_maxPendingReads, m_nodeId, m_pendingQueue, m_pendingReadMutex, ns3::MakeEvent(), NS_LOG_FUNCTION, NS_LOG_WARN, and ns3::Simulator::ScheduleWithContext().

Referenced by ns3::DpdkNetDevice::HandleRx().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Send()

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

Definition at line 548 of file fd-net-device.cc.

References m_address, NS_LOG_FUNCTION, and SendFrom().

+ Here is the call graph for this function:

◆ SendFrom()

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

Definition at line 555 of file fd-net-device.cc.

References ns3::Packet::AddHeader(), ns3::AddPIHeader(), AllocateBuffer(), ns3::Mac48Address::ConvertFrom(), ns3::Packet::CopyData(), DIXPI, FreeBuffer(), ns3::Packet::GetSize(), ns3::Packet::GetUid(), IsLinkUp(), LLC, m_encapMode, m_macTxDropTrace, m_macTxTrace, m_mtu, m_promiscSnifferTrace, m_snifferTrace, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::EthernetHeader::SetDestination(), ns3::EthernetHeader::SetLengthType(), ns3::EthernetHeader::SetSource(), ns3::LlcSnapHeader::SetType(), and Write().

Referenced by Send(), and Send().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetAddress()

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

Set the address of this interface.

Parameters
addressaddress to set

Implements ns3::NetDevice.

Definition at line 660 of file fd-net-device.cc.

References first::address, ns3::Mac48Address::ConvertFrom(), and m_address.

+ Here is the call graph for this function:

◆ SetEncapsulationMode()

void ns3::FdNetDevice::SetEncapsulationMode ( FdNetDevice::EncapsulationMode  mode)

Set the link layer encapsulation mode of this device.

Parameters
modeThe link layer encapsulation mode of this device.

Definition at line 210 of file fd-net-device.cc.

References m_encapMode, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by ns3::PlanetLabFdNetDeviceHelper::InstallPriv().

+ Here is the caller graph for this function:

◆ SetFileDescriptor()

void ns3::FdNetDevice::SetFileDescriptor ( int  fd)

Set the associated file descriptor.

Definition at line 645 of file fd-net-device.cc.

References m_fd.

◆ SetIfIndex()

void ns3::FdNetDevice::SetIfIndex ( const uint32_t  index)
virtual
Parameters
indexifIndex of the device

Implements ns3::NetDevice.

Definition at line 679 of file fd-net-device.cc.

References m_ifIndex.

◆ SetIsBroadcast()

void ns3::FdNetDevice::SetIsBroadcast ( bool  broadcast)
virtual

Set if the NetDevice is able to send Broadcast messages.

Parameters
broadcasttrue if the NetDevice can send Broadcast

Definition at line 734 of file fd-net-device.cc.

References m_isBroadcast.

◆ SetIsMulticast()

void ns3::FdNetDevice::SetIsMulticast ( bool  multicast)
virtual

Set if the NetDevice is able to send Multicast messages.

Parameters
multicasttrue if the NetDevice can send Multicast

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

References m_isMulticast.

◆ SetMtu()

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

Definition at line 697 of file fd-net-device.cc.

References m_mtu.

◆ SetNode()

void ns3::FdNetDevice::SetNode ( Ptr< Node node)
virtual
Parameters
nodethe node associated to this netdevice.

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

Implements ns3::NetDevice.

Definition at line 788 of file fd-net-device.cc.

References ns3::Node::GetId(), m_node, and m_nodeId.

+ Here is the call graph for this function:

◆ SetPromiscReceiveCallback()

void ns3::FdNetDevice::SetPromiscReceiveCallback ( NetDevice::PromiscReceiveCallback  cb)
virtual
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.

Definition at line 811 of file fd-net-device.cc.

References m_promiscRxCallback.

◆ SetReceiveCallback()

void ns3::FdNetDevice::SetReceiveCallback ( NetDevice::ReceiveCallback  cb)
virtual
Parameters
cbcallback to invoke whenever a packet has been received and must be forwarded to the higher layers.

Set the callback to be used to notify higher layers when a packet has been received.

Implements ns3::NetDevice.

Definition at line 805 of file fd-net-device.cc.

References m_rxCallback.

◆ Start()

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

Set a start time for the device.

Parameters
tStartthe start time

Definition at line 225 of file fd-net-device.cc.

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

Referenced by DoInitialize().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ StartDevice()

void ns3::FdNetDevice::StartDevice ( void  )
private

Spin up the device.

Definition at line 241 of file fd-net-device.cc.

References DoCreateFdReader(), DoFinishStartingDevice(), m_fd, m_fdReader, ns3::MakeCallback(), NotifyLinkUp(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by Start().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Stop()

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

Set a stop time for the device.

Parameters
tStopthe stop time

Definition at line 233 of file fd-net-device.cc.

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

Referenced by DoInitialize().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ StopDevice()

void ns3::FdNetDevice::StopDevice ( void  )
private

Tear down the device.

Definition at line 283 of file fd-net-device.cc.

References DoFinishStoppingDevice(), m_fd, m_fdReader, and NS_LOG_FUNCTION.

Referenced by DoDispose(), and Stop().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SupportsSendFrom()

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

Implements ns3::NetDevice.

Definition at line 817 of file fd-net-device.cc.

◆ TransmitStart()

bool ns3::FdNetDevice::TransmitStart ( Ptr< Packet p)
private

Start Sending a Packet Down the Wire.

Parameters
ppacket to send
Returns
true if success, false on failure

◆ Write()

ssize_t ns3::FdNetDevice::Write ( uint8_t *  buffer,
size_t  length 
)
virtual

Write packet data to device.

Parameters
bufferThe data.
lengthThe data length.
Returns
The size of data written.

Reimplemented in ns3::NetmapNetDevice, and ns3::DpdkNetDevice.

Definition at line 636 of file fd-net-device.cc.

References m_fd, and NS_LOG_FUNCTION.

Referenced by Send(), and SendFrom().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_address

Mac48Address ns3::FdNetDevice::m_address
private

The net device mac address.

Definition at line 324 of file fd-net-device.h.

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

◆ m_encapMode

EncapsulationMode ns3::FdNetDevice::m_encapMode
private

The type of encapsulation of the received/transmitted frames.

Definition at line 329 of file fd-net-device.h.

Referenced by ForwardUp(), GetEncapsulationMode(), GetTypeId(), SendFrom(), and SetEncapsulationMode().

◆ m_fd

int ns3::FdNetDevice::m_fd
private

The file descriptor used for receive/send network traffic.

Definition at line 314 of file fd-net-device.h.

Referenced by GetFileDescriptor(), SetFileDescriptor(), StartDevice(), StopDevice(), and Write().

◆ m_fdReader

Ptr<FdReader> ns3::FdNetDevice::m_fdReader
private

Reader for the file descriptor.

Definition at line 319 of file fd-net-device.h.

Referenced by StartDevice(), and StopDevice().

◆ m_ifIndex

uint32_t ns3::FdNetDevice::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 304 of file fd-net-device.h.

Referenced by GetIfIndex(), and SetIfIndex().

◆ m_isBroadcast

bool ns3::FdNetDevice::m_isBroadcast
private

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

Definition at line 346 of file fd-net-device.h.

Referenced by IsBroadcast(), and SetIsBroadcast().

◆ m_isMulticast

bool ns3::FdNetDevice::m_isMulticast
private

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

Definition at line 352 of file fd-net-device.h.

Referenced by IsMulticast(), and SetIsMulticast().

◆ m_linkChangeCallbacks

TracedCallback ns3::FdNetDevice::m_linkChangeCallbacks
private

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

Definition at line 340 of file fd-net-device.h.

Referenced by AddLinkChangeCallback(), and NotifyLinkUp().

◆ m_linkUp

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

Definition at line 335 of file fd-net-device.h.

Referenced by IsLinkUp(), and NotifyLinkUp().

◆ m_macPromiscRxTrace

TracedCallback<Ptr<const Packet> > ns3::FdNetDevice::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.

See also
class CallBackTraceSource

Definition at line 411 of file fd-net-device.h.

Referenced by ForwardUp(), and GetTypeId().

◆ m_macRxDropTrace

TracedCallback<Ptr<const Packet> > ns3::FdNetDevice::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).

See also
class CallBackTraceSource

Definition at line 429 of file fd-net-device.h.

◆ m_macRxTrace

TracedCallback<Ptr<const Packet> > ns3::FdNetDevice::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.

See also
class CallBackTraceSource

Definition at line 420 of file fd-net-device.h.

Referenced by ForwardUp(), and GetTypeId().

◆ m_macTxDropTrace

TracedCallback<Ptr<const Packet> > ns3::FdNetDevice::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.

See also
class CallBackTraceSource

Definition at line 402 of file fd-net-device.h.

Referenced by GetTypeId(), and SendFrom().

◆ m_macTxTrace

TracedCallback<Ptr<const Packet> > ns3::FdNetDevice::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.

See also
class CallBackTraceSource

Definition at line 394 of file fd-net-device.h.

Referenced by GetTypeId(), and SendFrom().

◆ m_maxPendingReads

uint32_t ns3::FdNetDevice::m_maxPendingReads
private

Maximum number of packets that can be received and scheduled for read but not yet read.

Definition at line 357 of file fd-net-device.h.

Referenced by GetTypeId(), and ReceiveCallback().

◆ m_mtu

uint16_t ns3::FdNetDevice::m_mtu
private

The MTU associated to the file descriptor technology.

Definition at line 309 of file fd-net-device.h.

Referenced by DoCreateFdReader(), GetMtu(), SendFrom(), and SetMtu().

◆ m_node

Ptr<Node> ns3::FdNetDevice::m_node
private

The ns-3 node associated to the net device.

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

Referenced by GetNode(), and SetNode().

◆ m_nodeId

uint32_t ns3::FdNetDevice::m_nodeId
private

a copy of the node id so the read thread doesn't have to GetNode() in in order to find the node ID.

Thread unsafe reference counting in multithreaded apps is not a good thing.

Definition at line 299 of file fd-net-device.h.

Referenced by ReceiveCallback(), and SetNode().

◆ m_pendingQueue

std::queue< std::pair<uint8_t *, ssize_t> > ns3::FdNetDevice::m_pendingQueue
protected

Number of packets that were received and scheduled for read but not yet read.

Definition at line 235 of file fd-net-device.h.

Referenced by ns3::DpdkNetDevice::DoFinishStoppingDevice(), ForwardUp(), and ReceiveCallback().

◆ m_pendingReadMutex

SystemMutex ns3::FdNetDevice::m_pendingReadMutex
protected

Mutex to increase pending read counter.

Definition at line 230 of file fd-net-device.h.

Referenced by ns3::DpdkNetDevice::DoFinishStoppingDevice(), ForwardUp(), and ReceiveCallback().

◆ m_phyRxDropTrace

TracedCallback<Ptr<const Packet> > ns3::FdNetDevice::m_phyRxDropTrace
private

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

See also
class CallBackTraceSource

Definition at line 446 of file fd-net-device.h.

Referenced by ForwardUp().

◆ m_phyTxDropTrace

TracedCallback<Ptr<const Packet> > ns3::FdNetDevice::m_phyTxDropTrace
private

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

Todo:
Remove: this TracedCallback is never invoked.
See also
class CallBackTraceSource

Definition at line 439 of file fd-net-device.h.

◆ m_promiscRxCallback

NetDevice::PromiscReceiveCallback ns3::FdNetDevice::m_promiscRxCallback
private

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

Definition at line 386 of file fd-net-device.h.

Referenced by ForwardUp(), and SetPromiscReceiveCallback().

◆ m_promiscSnifferTrace

TracedCallback<Ptr<const Packet> > ns3::FdNetDevice::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.

See also
class CallBackTraceSource

Definition at line 486 of file fd-net-device.h.

Referenced by ForwardUp(), GetTypeId(), and SendFrom().

◆ m_rxCallback

NetDevice::ReceiveCallback ns3::FdNetDevice::m_rxCallback
private

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

Definition at line 381 of file fd-net-device.h.

Referenced by ForwardUp(), and SetReceiveCallback().

◆ m_snifferTrace

TracedCallback<Ptr<const Packet> > ns3::FdNetDevice::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.

See also
class CallBackTraceSource

Definition at line 466 of file fd-net-device.h.

Referenced by ForwardUp(), GetTypeId(), and SendFrom().

◆ m_startEvent

EventId ns3::FdNetDevice::m_startEvent
private

NetDevice start event.

Definition at line 372 of file fd-net-device.h.

Referenced by Start().

◆ m_stopEvent

EventId ns3::FdNetDevice::m_stopEvent
private

NetDevice stop event.

Definition at line 376 of file fd-net-device.h.

Referenced by Stop().

◆ m_tStart

Time ns3::FdNetDevice::m_tStart
private

Time to start spinning up the device.

Definition at line 362 of file fd-net-device.h.

Referenced by DoInitialize(), and GetTypeId().

◆ m_tStop

Time ns3::FdNetDevice::m_tStop
private

Time to start tearing down the device.

Definition at line 367 of file fd-net-device.h.

Referenced by DoInitialize(), and GetTypeId().


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