a virtual net device that bridges multiple LAN segments More...
#include "bridge-net-device.h"
Classes | |
struct | LearnedState |
Structure holding the status of an address. More... | |
Public Member Functions | |
BridgeNetDevice () | |
BridgeNetDevice (const BridgeNetDevice &)=delete | |
~BridgeNetDevice () override | |
void | AddBridgePort (Ptr< NetDevice > bridgePort) |
Add a 'port' to a bridge device. | |
void | AddLinkChangeCallback (Callback< void > callback) override |
Address | GetAddress () const override |
Ptr< NetDevice > | GetBridgePort (uint32_t n) const |
Gets the n-th bridged port. | |
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. | |
uint32_t | GetNBridgePorts () const |
Gets the number of bridged 'ports', i.e., the NetDevices currently bridged. | |
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 |
BridgeNetDevice & | operator= (const BridgeNetDevice &)=delete |
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 |
bool | SetMtu (const uint16_t mtu) override |
void | SetNode (Ptr< Node > node) override |
void | SetPromiscReceiveCallback (NetDevice::PromiscReceiveCallback cb) override |
void | SetReceiveCallback (NetDevice::ReceiveCallback cb) override |
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. | |
void | ForwardBroadcast (Ptr< NetDevice > incomingPort, Ptr< const Packet > packet, uint16_t protocol, Mac48Address src, Mac48Address dst) |
Forwards a broadcast or a multicast packet. | |
void | ForwardUnicast (Ptr< NetDevice > incomingPort, Ptr< const Packet > packet, uint16_t protocol, Mac48Address src, Mac48Address dst) |
Forwards a unicast packet. | |
Ptr< NetDevice > | GetLearnedState (Mac48Address source) |
Gets the port associated to a source address. | |
void | Learn (Mac48Address source, Ptr< NetDevice > port) |
Learns the port a MAC address is sending from. | |
void | ReceiveFromDevice (Ptr< NetDevice > device, Ptr< const Packet > packet, uint16_t protocol, const Address &source, const Address &destination, PacketType packetType) |
Receives a packet from one bridged port. | |
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 | |
Mac48Address | m_address |
MAC address of the NetDevice. | |
Ptr< BridgeChannel > | m_channel |
virtual bridged channel | |
bool | m_enableLearning |
true if the bridge will learn the node status | |
Time | m_expirationTime |
time it takes for learned MAC state to expire | |
uint32_t | m_ifIndex |
Interface index. | |
std::map< Mac48Address, LearnedState > | m_learnState |
Container for known address statuses. | |
uint16_t | m_mtu |
MTU of the bridged NetDevice. | |
Ptr< Node > | m_node |
node owning this NetDevice | |
std::vector< Ptr< NetDevice > > | m_ports |
bridged ports | |
NetDevice::PromiscReceiveCallback | m_promiscRxCallback |
promiscuous receive callback | |
NetDevice::ReceiveCallback | m_rxCallback |
receive callback | |
Additional Inherited Members | |
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 |
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 net device that bridges multiple LAN segments
ns3::BridgeNetDevice is accessible through the following paths with Config::Set and Config::Connect:
Time
-9.22337e+18ns:+9.22337e+18ns No TraceSources are defined for this type.
Group: Bridge
Size of this type is 184 bytes (on a 64-bit architecture).
Definition at line 62 of file bridge-net-device.h.
ns3::BridgeNetDevice::BridgeNetDevice | ( | ) |
Definition at line 55 of file bridge-net-device.cc.
References ns3::CreateObject(), m_channel, and NS_LOG_FUNCTION_NOARGS.
|
override |
Definition at line 63 of file bridge-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
|
delete |
Add a 'port' to a bridge device.
bridgePort | the NetDevice to add |
This method adds a new bridge port to a BridgeNetDevice, so that the new bridge port NetDevice becomes part of the bridge and L2 frames start being forwarded to/from this NetDevice.
Definition at line 248 of file bridge-net-device.cc.
References ns3::Mac48Address::ConvertFrom(), ns3::Mac48Address::IsMatchingType(), m_address, m_channel, m_node, m_ports, ns3::MakeCallback(), NS_ASSERT, NS_FATAL_ERROR, NS_LOG_DEBUG, NS_LOG_FUNCTION_NOARGS, ReceiveFromDevice(), and ns3::Node::RegisterProtocolHandler().
|
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 332 of file bridge-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 69 of file bridge-net-device.cc.
References ns3::Object::DoDispose(), m_channel, m_node, m_ports, and NS_LOG_FUNCTION_NOARGS.
|
protected |
Forwards a broadcast or a multicast packet.
incomingPort | the packet incoming port |
packet | the packet |
protocol | the packet protocol (e.g., Ethertype) |
src | the packet source |
dst | the packet destination |
Definition at line 171 of file bridge-net-device.cc.
References Learn(), m_ports, NS_LOG_DEBUG, NS_LOG_FUNCTION_NOARGS, NS_LOG_LOGIC, and port.
Referenced by ReceiveFromDevice().
|
protected |
Forwards a unicast packet.
incomingPort | the packet incoming port |
packet | the packet |
protocol | the packet protocol (e.g., Ethertype) |
src | the packet source |
dst | the packet destination |
Definition at line 132 of file bridge-net-device.cc.
References GetLearnedState(), Learn(), m_ports, NS_LOG_DEBUG, NS_LOG_FUNCTION_NOARGS, NS_LOG_LOGIC, and port.
Referenced by ReceiveFromDevice().
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 303 of file bridge-net-device.cc.
References m_address, and NS_LOG_FUNCTION_NOARGS.
Gets the n-th bridged port.
n | the port index |
Definition at line 241 of file bridge-net-device.cc.
References m_ports, and NS_LOG_FUNCTION_NOARGS.
|
overridevirtual |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Definition at line 344 of file bridge-net-device.cc.
References ns3::Mac48Address::GetBroadcast(), and NS_LOG_FUNCTION_NOARGS.
Implements ns3::NetDevice.
Definition at line 289 of file bridge-net-device.cc.
References m_channel, and NS_LOG_FUNCTION_NOARGS.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 282 of file bridge-net-device.cc.
References m_ifIndex, and NS_LOG_FUNCTION_NOARGS.
|
protected |
Gets the port associated to a source address.
source | the source address |
Definition at line 210 of file bridge-net-device.cc.
References ns3::BridgeNetDevice::LearnedState::associatedPort, ns3::BridgeNetDevice::LearnedState::expirationTime, m_enableLearning, m_learnState, ns3::Simulator::Now(), and NS_LOG_FUNCTION_NOARGS.
Referenced by ForwardUnicast(), and SendFrom().
|
overridevirtual |
This value is typically used by the IP layer to perform IP fragmentation when needed.
Implements ns3::NetDevice.
Definition at line 318 of file bridge-net-device.cc.
References m_mtu, and NS_LOG_FUNCTION_NOARGS.
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 358 of file bridge-net-device.cc.
References ns3::Mac48Address::GetMulticast(), and NS_LOG_FUNCTION.
|
overridevirtual |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
Implements ns3::NetDevice.
Definition at line 462 of file bridge-net-device.cc.
References ns3::Mac48Address::GetMulticast(), and NS_LOG_FUNCTION.
uint32_t ns3::BridgeNetDevice::GetNBridgePorts | ( | ) | const |
Gets the number of bridged 'ports', i.e., the NetDevices currently bridged.
Definition at line 234 of file bridge-net-device.cc.
References m_ports, and NS_LOG_FUNCTION_NOARGS.
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 420 of file bridge-net-device.cc.
References m_node, and NS_LOG_FUNCTION_NOARGS.
|
static |
Get the type ID.
Definition at line 30 of file bridge-net-device.cc.
References GetMtu(), m_enableLearning, m_expirationTime, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), ns3::Seconds(), SetMtu(), and ns3::TypeId::SetParent().
|
overridevirtual |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
Definition at line 373 of file bridge-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 337 of file bridge-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 325 of file bridge-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 351 of file bridge-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
|
overridevirtual |
Return true if the net device is on a point-to-point link.
Implements ns3::NetDevice.
Definition at line 366 of file bridge-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
|
protected |
Learns the port a MAC address is sending from.
source | source address |
port | the port the source is sending from |
Definition at line 198 of file bridge-net-device.cc.
References ns3::BridgeNetDevice::LearnedState::associatedPort, ns3::BridgeNetDevice::LearnedState::expirationTime, m_enableLearning, m_expirationTime, m_learnState, ns3::Simulator::Now(), NS_LOG_FUNCTION_NOARGS, and port.
Referenced by ForwardBroadcast(), ForwardUnicast(), and ReceiveFromDevice().
|
overridevirtual |
Called by higher-layers to check if this NetDevice requires ARP to be used.
Implements ns3::NetDevice.
Definition at line 434 of file bridge-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
|
delete |
|
protected |
Receives a packet from one bridged port.
device | the originating port |
packet | the received packet |
protocol | the packet protocol (e.g., Ethertype) |
source | the packet source |
destination | the packet destination |
packetType | the packet type (e.g., host, broadcast, etc.) |
Definition at line 83 of file bridge-net-device.cc.
References ns3::Mac48Address::ConvertFrom(), ForwardBroadcast(), ForwardUnicast(), ns3::Callback< R, UArgs >::IsNull(), Learn(), m_address, m_promiscRxCallback, m_rxCallback, NS_LOG_DEBUG, NS_LOG_FUNCTION_NOARGS, ns3::NetDevice::PACKET_BROADCAST, ns3::NetDevice::PACKET_HOST, ns3::NetDevice::PACKET_MULTICAST, and ns3::NetDevice::PACKET_OTHERHOST.
Referenced by AddBridgePort().
|
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 380 of file bridge-net-device.cc.
References m_address, NS_LOG_FUNCTION_NOARGS, and SendFrom().
|
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 387 of file bridge-net-device.cc.
References ns3::Mac48Address::ConvertFrom(), GetLearnedState(), ns3::Mac48Address::IsGroup(), m_ports, NS_LOG_FUNCTION_NOARGS, and port.
Referenced by Send().
|
overridevirtual |
Set the address of this interface.
address | address to set |
Implements ns3::NetDevice.
Definition at line 296 of file bridge-net-device.cc.
References ns3::Mac48Address::ConvertFrom(), m_address, and NS_LOG_FUNCTION_NOARGS.
|
overridevirtual |
index | ifIndex of the device |
Implements ns3::NetDevice.
Definition at line 275 of file bridge-net-device.cc.
References m_ifIndex, and NS_LOG_FUNCTION_NOARGS.
|
overridevirtual |
mtu | MTU value, in bytes, to set for the device |
Override for default MTU defined on a per-type basis.
Implements ns3::NetDevice.
Definition at line 310 of file bridge-net-device.cc.
References m_mtu, and NS_LOG_FUNCTION_NOARGS.
Referenced by GetTypeId().
node | the node associated to this netdevice. |
This method is called from ns3::Node::AddDevice.
Implements ns3::NetDevice.
Definition at line 427 of file bridge-net-device.cc.
References m_node, and NS_LOG_FUNCTION_NOARGS.
|
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 448 of file bridge-net-device.cc.
References m_promiscRxCallback, and NS_LOG_FUNCTION_NOARGS.
|
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 441 of file bridge-net-device.cc.
References m_rxCallback, and NS_LOG_FUNCTION_NOARGS.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 455 of file bridge-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
|
private |
MAC address of the NetDevice.
Definition at line 200 of file bridge-net-device.h.
Referenced by AddBridgePort(), GetAddress(), ReceiveFromDevice(), Send(), and SetAddress().
|
private |
virtual bridged channel
Definition at line 215 of file bridge-net-device.h.
Referenced by BridgeNetDevice(), AddBridgePort(), DoDispose(), and GetChannel().
|
private |
true if the bridge will learn the node status
Definition at line 219 of file bridge-net-device.h.
Referenced by GetLearnedState(), GetTypeId(), and Learn().
|
private |
time it takes for learned MAC state to expire
Definition at line 201 of file bridge-net-device.h.
Referenced by GetTypeId(), and Learn().
|
private |
Interface index.
Definition at line 217 of file bridge-net-device.h.
Referenced by GetIfIndex(), and SetIfIndex().
|
private |
Container for known address statuses.
Definition at line 213 of file bridge-net-device.h.
Referenced by GetLearnedState(), and Learn().
|
private |
MTU of the bridged NetDevice.
Definition at line 218 of file bridge-net-device.h.
node owning this NetDevice
Definition at line 214 of file bridge-net-device.h.
Referenced by AddBridgePort(), DoDispose(), GetNode(), and SetNode().
bridged ports
Definition at line 216 of file bridge-net-device.h.
Referenced by AddBridgePort(), DoDispose(), ForwardBroadcast(), ForwardUnicast(), GetBridgePort(), GetNBridgePorts(), and SendFrom().
|
private |
promiscuous receive callback
Definition at line 198 of file bridge-net-device.h.
Referenced by ReceiveFromDevice(), and SetPromiscReceiveCallback().
|
private |
receive callback
Definition at line 197 of file bridge-net-device.h.
Referenced by ReceiveFromDevice(), and SetReceiveCallback().