A virtual device, similar to Linux TUN/TAP interfaces. More...
#include "virtual-net-device.h"
Public Types | |
typedef Callback< bool, Ptr< Packet >, const Address &, const Address &, uint16_t > | SendCallback |
Callback the be invoked when the VirtualNetDevice is asked to queue/transmit a packet. | |
Public Types inherited from ns3::NetDevice | |
typedef void(* | LinkChangeTracedCallback) () |
TracedCallback signature for link changed event. | |
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 &, PacketType > | PromiscReceiveCallback |
typedef Callback< bool, Ptr< NetDevice >, Ptr< const Packet >, uint16_t, const Address & > | ReceiveCallback |
Public Member Functions | |
VirtualNetDevice () | |
~VirtualNetDevice () override | |
void | AddLinkChangeCallback (Callback< void > callback) override |
Address | GetAddress () const override |
Address | GetBroadcast () const override |
Ptr< Channel > | GetChannel () const override |
uint32_t | GetIfIndex () const override |
uint16_t | GetMtu () const override |
Address | GetMulticast (Ipv4Address multicastGroup) const override |
Make and return a MAC multicast address using the provided multicast group. | |
Address | GetMulticast (Ipv6Address addr) const override |
Get the MAC multicast address corresponding to the IPv6 address provided. | |
Ptr< Node > | GetNode () const override |
bool | IsBridge () const override |
Return true if the net device is acting as a bridge. | |
bool | IsBroadcast () const override |
bool | IsLinkUp () const override |
bool | IsMulticast () const override |
bool | IsPointToPoint () const override |
Return true if the net device is on a point-to-point link. | |
bool | NeedsArp () const override |
bool | Receive (Ptr< Packet > packet, uint16_t protocol, const Address &source, const Address &destination, PacketType packetType) |
bool | Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber) override |
bool | SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber) override |
void | SetAddress (Address address) override |
Set the address of this interface. | |
void | SetIfIndex (const uint32_t index) override |
void | SetIsPointToPoint (bool isPointToPoint) |
Configure whether the virtual device is point-to-point. | |
bool | SetMtu (const uint16_t mtu) override |
Configure the reported MTU for the virtual device. | |
void | SetNeedsArp (bool needsArp) |
Configure whether the virtual device needs ARP. | |
void | SetNode (Ptr< Node > node) override |
void | SetPromiscReceiveCallback (NetDevice::PromiscReceiveCallback cb) override |
void | SetReceiveCallback (NetDevice::ReceiveCallback cb) override |
void | SetSendCallback (SendCallback transmitCb) |
Set the user callback to be called when a L2 packet is to be transmitted. | |
void | SetSupportsSendFrom (bool supportsSendFrom) |
Configure whether the virtual device supports SendFrom. | |
bool | SupportsSendFrom () const override |
Public Member Functions inherited from ns3::NetDevice | |
~NetDevice () override | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::NetDevice | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Protected Member Functions | |
void | DoDispose () override |
Destructor implementation. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Private Attributes | |
uint32_t | m_index |
Device index. | |
bool | m_isPointToPoint |
True if the device is a PointToPoint type device. | |
TracedCallback< Ptr< const Packet > > | m_macPromiscRxTrace |
Promisc Rx trace. | |
TracedCallback< Ptr< const Packet > > | m_macRxTrace |
Rx trace. | |
TracedCallback< Ptr< const Packet > > | m_macTxTrace |
Tx trace. | |
uint16_t | m_mtu |
MTU. | |
Address | m_myAddress |
MAC address. | |
std::string | m_name |
Name of the device. | |
bool | m_needsArp |
True if the device needs ARP. | |
Ptr< Node > | m_node |
Pointer to the node. | |
PromiscReceiveCallback | m_promiscRxCallback |
Promisc Rx callback. | |
TracedCallback< Ptr< const Packet > > | m_promiscSnifferTrace |
Promisc Sniffer trace. | |
ReceiveCallback | m_rxCallback |
Rx callback. | |
SendCallback | m_sendCb |
send callback | |
TracedCallback< Ptr< const Packet > > | m_snifferTrace |
Sniffer trace. | |
bool | m_supportsSendFrom |
True if the device supports SendFrm. | |
Additional Inherited Members | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
A virtual device, similar to Linux TUN/TAP interfaces.
A VirtualNetDevice is a "virtual" NetDevice implementation which delegates to a user callback (see method SetSendCallback()) the task of actually transmitting a packet. It also allows the user code to inject the packet as if it had been received by the VirtualNetDevice. Together, these features allow one to build tunnels. For instance, by transmitting packets into a UDP socket we end up building an IP-over-UDP-over-IP tunnel, or IP-over-IP tunnels.
The same thing could be accomplished by subclassing NetDevice directly. However, VirtualNetDevice is usually much simpler to program than a NetDevice subclass.
ns3::VirtualNetDevice is accessible through the following paths with Config::Set and Config::Connect:
Group: VirtualNetDevice
Size of this type is 280 bytes (on a 64-bit architecture).
Definition at line 46 of file virtual-net-device.h.
typedef Callback<bool, Ptr<Packet>, const Address&, const Address&, uint16_t> ns3::VirtualNetDevice::SendCallback |
Callback the be invoked when the VirtualNetDevice is asked to queue/transmit a packet.
For more information, consult the documentation of NetDevice::SendFrom().
Definition at line 53 of file virtual-net-device.h.
ns3::VirtualNetDevice::VirtualNetDevice | ( | ) |
Definition at line 76 of file virtual-net-device.cc.
References m_isPointToPoint, m_needsArp, and m_supportsSendFrom.
|
override |
Definition at line 114 of file virtual-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
|
overridevirtual |
callback | the 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 203 of file virtual-net-device.cc.
|
overrideprotectedvirtual |
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 120 of file virtual-net-device.cc.
References ns3::Object::DoDispose(), m_node, and NS_LOG_FUNCTION_NOARGS.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 179 of file virtual-net-device.cc.
References m_myAddress.
Referenced by Send().
|
overridevirtual |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Definition at line 214 of file virtual-net-device.cc.
References ns3::Mac48Address::GetBroadcast().
Implements ns3::NetDevice.
Definition at line 173 of file virtual-net-device.cc.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 167 of file virtual-net-device.cc.
References m_index.
|
overridevirtual |
This value is typically used by the IP layer to perform IP fragmentation when needed.
Implements ns3::NetDevice.
Definition at line 191 of file virtual-net-device.cc.
References m_mtu.
Referenced by GetTypeId().
|
overridevirtual |
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.
multicastGroup | The IP address for the multicast group destination of the packet. |
Implements ns3::NetDevice.
Definition at line 226 of file virtual-net-device.cc.
References ns3::Mac48Address::GetBroadcast().
|
overridevirtual |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
Implements ns3::NetDevice.
Definition at line 232 of file virtual-net-device.cc.
References ns3::Mac48Address::GetBroadcast().
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 262 of file virtual-net-device.cc.
References m_node.
|
static |
Get the type ID.
Definition at line 28 of file virtual-net-device.cc.
References GetMtu(), m_macPromiscRxTrace, m_macRxTrace, m_macTxTrace, m_promiscSnifferTrace, m_snifferTrace, ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), SetMtu(), and ns3::TypeId::SetParent().
|
overridevirtual |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
Definition at line 298 of file virtual-net-device.cc.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 208 of file virtual-net-device.cc.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 197 of file virtual-net-device.cc.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 220 of file virtual-net-device.cc.
|
overridevirtual |
Return true if the net device is on a point-to-point link.
Implements ns3::NetDevice.
Definition at line 238 of file virtual-net-device.cc.
References m_isPointToPoint.
|
overridevirtual |
Called by higher-layers to check if this NetDevice requires ARP to be used.
Implements ns3::NetDevice.
Definition at line 274 of file virtual-net-device.cc.
References m_needsArp.
bool ns3::VirtualNetDevice::Receive | ( | Ptr< Packet > | packet, |
uint16_t | protocol, | ||
const Address & | source, | ||
const Address & | destination, | ||
PacketType | packetType ) |
packet | packet sent from below up to Network Device |
protocol | Protocol type |
source | the address of the sender of this packet. |
destination | the address of the receiver of this packet. |
packetType | type of packet received (broadcast/multicast/unicast/otherhost) |
Forward a "virtually received" packet up the node's protocol stack.
Definition at line 128 of file virtual-net-device.cc.
References ns3::Callback< R, UArgs >::IsNull(), m_macPromiscRxTrace, m_macRxTrace, m_promiscRxCallback, m_promiscSnifferTrace, m_rxCallback, m_snifferTrace, and ns3::NetDevice::PACKET_OTHERHOST.
|
overridevirtual |
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
Implements ns3::NetDevice.
Definition at line 244 of file virtual-net-device.cc.
References GetAddress(), m_macTxTrace, and m_sendCb.
|
overridevirtual |
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.
Implements ns3::NetDevice.
Definition at line 251 of file virtual-net-device.cc.
References m_macTxTrace, m_sendCb, m_supportsSendFrom, and NS_ASSERT.
|
overridevirtual |
Set the address of this interface.
address | address to set |
Implements ns3::NetDevice.
Definition at line 185 of file virtual-net-device.cc.
References m_myAddress.
|
overridevirtual |
index | ifIndex of the device |
Implements ns3::NetDevice.
Definition at line 161 of file virtual-net-device.cc.
References m_index.
void ns3::VirtualNetDevice::SetIsPointToPoint | ( | bool | isPointToPoint | ) |
Configure whether the virtual device is point-to-point.
isPointToPoint | the value that should be returned by the IsPointToPoint method for this instance. |
Definition at line 102 of file virtual-net-device.cc.
References m_isPointToPoint.
|
overridevirtual |
Configure the reported MTU for the virtual device.
mtu | MTU value to set |
Implements ns3::NetDevice.
Definition at line 108 of file virtual-net-device.cc.
References m_mtu.
Referenced by GetTypeId().
void ns3::VirtualNetDevice::SetNeedsArp | ( | bool | needsArp | ) |
Configure whether the virtual device needs ARP.
needsArp | the the 'needs arp' value that will be returned by the NeedsArp() method. The method IsBroadcast() will also return this value. |
Definition at line 90 of file virtual-net-device.cc.
References m_needsArp.
node | the node associated to this netdevice. |
This method is called from ns3::Node::AddDevice.
Implements ns3::NetDevice.
Definition at line 268 of file virtual-net-device.cc.
References m_node.
|
overridevirtual |
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 286 of file virtual-net-device.cc.
References m_promiscRxCallback.
|
overridevirtual |
cb | callback 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 280 of file virtual-net-device.cc.
References m_rxCallback.
void ns3::VirtualNetDevice::SetSendCallback | ( | SendCallback | transmitCb | ) |
Set the user callback to be called when a L2 packet is to be transmitted.
transmitCb | the new transmit callback |
Definition at line 84 of file virtual-net-device.cc.
References m_sendCb.
void ns3::VirtualNetDevice::SetSupportsSendFrom | ( | bool | supportsSendFrom | ) |
Configure whether the virtual device supports SendFrom.
supportsSendFrom | true if the device supports SendFrom |
Definition at line 96 of file virtual-net-device.cc.
References m_supportsSendFrom.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 292 of file virtual-net-device.cc.
References m_supportsSendFrom.
|
private |
Device index.
Definition at line 160 of file virtual-net-device.h.
Referenced by GetIfIndex(), and SetIfIndex().
|
private |
True if the device is a PointToPoint type device.
Definition at line 164 of file virtual-net-device.h.
Referenced by VirtualNetDevice(), IsPointToPoint(), and SetIsPointToPoint().
|
private |
Promisc Rx trace.
Definition at line 153 of file virtual-net-device.h.
Referenced by GetTypeId(), and Receive().
|
private |
Rx trace.
Definition at line 151 of file virtual-net-device.h.
Referenced by GetTypeId(), and Receive().
|
private |
Tx trace.
Definition at line 152 of file virtual-net-device.h.
Referenced by GetTypeId(), Send(), and SendFrom().
|
private |
|
private |
MAC address.
Definition at line 149 of file virtual-net-device.h.
Referenced by GetAddress(), and SetAddress().
|
private |
Name of the device.
Definition at line 159 of file virtual-net-device.h.
|
private |
True if the device needs ARP.
Definition at line 162 of file virtual-net-device.h.
Referenced by VirtualNetDevice(), NeedsArp(), and SetNeedsArp().
Pointer to the node.
Definition at line 156 of file virtual-net-device.h.
Referenced by DoDispose(), GetNode(), and SetNode().
|
private |
Promisc Rx callback.
Definition at line 158 of file virtual-net-device.h.
Referenced by Receive(), and SetPromiscReceiveCallback().
|
private |
Promisc Sniffer trace.
Definition at line 155 of file virtual-net-device.h.
Referenced by GetTypeId(), and Receive().
|
private |
Rx callback.
Definition at line 157 of file virtual-net-device.h.
Referenced by Receive(), and SetReceiveCallback().
|
private |
send callback
Definition at line 150 of file virtual-net-device.h.
Referenced by Send(), SendFrom(), and SetSendCallback().
|
private |
Sniffer trace.
Definition at line 154 of file virtual-net-device.h.
Referenced by GetTypeId(), and Receive().
|
private |
True if the device supports SendFrm.
Definition at line 163 of file virtual-net-device.h.
Referenced by VirtualNetDevice(), SendFrom(), SetSupportsSendFrom(), and SupportsSendFrom().