a virtual net device that bridges multiple LAN segments More...
#include <bridge-net-device.h>
Classes | |
struct | LearnedState |
Public Member Functions | |
BridgeNetDevice () | |
virtual | ~BridgeNetDevice () |
void | AddBridgePort (Ptr< NetDevice > bridgePort) |
Add a 'port' to a bridge device. | |
uint32_t | GetNBridgePorts (void) const |
Ptr< NetDevice > | GetBridgePort (uint32_t n) const |
virtual void | SetName (const std::string name) |
virtual std::string | GetName (void) const |
virtual void | SetIfIndex (const uint32_t index) |
virtual uint32_t | GetIfIndex (void) const |
virtual Ptr< Channel > | GetChannel (void) const |
virtual Address | GetAddress (void) const |
virtual bool | SetMtu (const uint16_t mtu) |
virtual uint16_t | GetMtu (void) const |
virtual bool | IsLinkUp (void) const |
virtual void | SetLinkChangeCallback (Callback< void > callback) |
virtual bool | IsBroadcast (void) const |
virtual Address | GetBroadcast (void) const |
virtual bool | IsMulticast (void) const |
virtual Address | GetMulticast (Ipv4Address multicastGroup) const |
Make and return a MAC multicast address using the provided multicast group. | |
virtual bool | IsPointToPoint (void) const |
Return true if the net device is on a point-to-point link. | |
virtual bool | IsBridge (void) const |
Return true if the net device is acting as a bridge. | |
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 (NetDevice::PromiscReceiveCallback cb) |
virtual bool | SupportsSendFrom () const |
virtual Address | GetMulticast (Ipv6Address addr) const |
Get the MAC multicast address corresponding to the IPv6 address provided. | |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
This method returns the TypeId associated to ns3::BridgeNetDevice. | |
Protected Member Functions | |
virtual void | DoDispose (void) |
void | ReceiveFromDevice (Ptr< NetDevice > device, Ptr< const Packet > packet, uint16_t protocol, Address const &source, Address const &destination, PacketType packetType) |
void | ForwardUnicast (Ptr< NetDevice > incomingPort, Ptr< const Packet > packet, uint16_t protocol, Mac48Address src, Mac48Address dst) |
void | ForwardBroadcast (Ptr< NetDevice > incomingPort, Ptr< const Packet > packet, uint16_t protocol, Mac48Address src, Mac48Address dst) |
void | Learn (Mac48Address source, Ptr< NetDevice > port) |
Ptr< NetDevice > | GetLearnedState (Mac48Address source) |
Private Attributes | |
NetDevice::ReceiveCallback | m_rxCallback |
NetDevice::PromiscReceiveCallback | m_promiscRxCallback |
Mac48Address | m_address |
Time | m_expirationTime |
std::map< Mac48Address, LearnedState > | m_learnState |
Ptr< Node > | m_node |
Ptr< BridgeChannel > | m_channel |
std::string | m_name |
std::vector< Ptr< NetDevice > > | m_ports |
uint32_t | m_ifIndex |
uint16_t | m_mtu |
bool | m_enableLearning |
a virtual net device that bridges multiple LAN segments
Definition at line 66 of file bridge-net-device.h.
ns3::BridgeNetDevice::BridgeNetDevice | ( | ) |
Definition at line 54 of file bridge-net-device.cc.
References m_channel, and NS_LOG_FUNCTION_NOARGS.
ns3::BridgeNetDevice::~BridgeNetDevice | ( | ) | [virtual] |
Definition at line 64 of file bridge-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
Add a 'port' to a bridge device.
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 228 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, and ReceiveFromDevice().
void ns3::BridgeNetDevice::DoDispose | ( | void | ) | [protected, virtual] |
This method is called by Object::Dispose or by the object's destructor, whichever comes first.
Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.
Reimplemented from ns3::Object.
Definition at line 70 of file bridge-net-device.cc.
References m_channel, m_node, m_ports, and NS_LOG_FUNCTION_NOARGS.
void ns3::BridgeNetDevice::ForwardBroadcast | ( | Ptr< NetDevice > | incomingPort, | |
Ptr< const Packet > | packet, | |||
uint16_t | protocol, | |||
Mac48Address | src, | |||
Mac48Address | dst | |||
) | [protected] |
Definition at line 154 of file bridge-net-device.cc.
References Learn(), m_ports, NS_LOG_DEBUG, NS_LOG_FUNCTION_NOARGS, and NS_LOG_LOGIC.
Referenced by ReceiveFromDevice().
void ns3::BridgeNetDevice::ForwardUnicast | ( | Ptr< NetDevice > | incomingPort, | |
Ptr< const Packet > | packet, | |||
uint16_t | protocol, | |||
Mac48Address | src, | |||
Mac48Address | dst | |||
) | [protected] |
Definition at line 120 of file bridge-net-device.cc.
References GetLearnedState(), Learn(), m_ports, NS_LOG_DEBUG, NS_LOG_FUNCTION_NOARGS, and NS_LOG_LOGIC.
Referenced by ReceiveFromDevice().
Address ns3::BridgeNetDevice::GetAddress | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
Definition at line 288 of file bridge-net-device.cc.
References m_address, and NS_LOG_FUNCTION_NOARGS.
Definition at line 221 of file bridge-net-device.cc.
References m_ports, and NS_LOG_FUNCTION_NOARGS.
Address ns3::BridgeNetDevice::GetBroadcast | ( | void | ) | const [virtual] |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Definition at line 332 of file bridge-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
Implements ns3::NetDevice.
Definition at line 281 of file bridge-net-device.cc.
References m_channel, and NS_LOG_FUNCTION_NOARGS.
uint32_t ns3::BridgeNetDevice::GetIfIndex | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
Definition at line 274 of file bridge-net-device.cc.
References m_ifIndex, and NS_LOG_FUNCTION_NOARGS.
Ptr< NetDevice > ns3::BridgeNetDevice::GetLearnedState | ( | Mac48Address | source | ) | [protected] |
Definition at line 188 of file bridge-net-device.cc.
References ns3::BridgeNetDevice::LearnedState::associatedPort, ns3::BridgeNetDevice::LearnedState::expirationTime, m_enableLearning, m_learnState, ns3::Now(), and NS_LOG_FUNCTION_NOARGS.
Referenced by ForwardUnicast().
uint16_t ns3::BridgeNetDevice::GetMtu | ( | void | ) | const [virtual] |
This value is typically used by the IP layer to perform IP fragmentation when needed.
Implements ns3::NetDevice.
Definition at line 303 of file bridge-net-device.cc.
References m_mtu, and NS_LOG_FUNCTION_NOARGS.
Address ns3::BridgeNetDevice::GetMulticast | ( | Ipv6Address | addr | ) | const [virtual] |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
Implements ns3::NetDevice.
Definition at line 443 of file bridge-net-device.cc.
References GetMulticast(), and NS_LOG_FUNCTION.
Address ns3::BridgeNetDevice::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.
A default imlementation of GetMulticast is provided, but this method simply NS_ASSERTS. 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 346 of file bridge-net-device.cc.
References NS_LOG_FUNCTION.
Referenced by GetMulticast().
std::string ns3::BridgeNetDevice::GetName | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
Definition at line 260 of file bridge-net-device.cc.
References m_name, and NS_LOG_FUNCTION_NOARGS.
uint32_t ns3::BridgeNetDevice::GetNBridgePorts | ( | void | ) | const |
Definition at line 213 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 399 of file bridge-net-device.cc.
References m_node, and NS_LOG_FUNCTION_NOARGS.
TypeId ns3::BridgeNetDevice::GetTypeId | ( | void | ) | [static] |
This method returns the TypeId associated to ns3::BridgeNetDevice.
This object is accessible through the following paths with Config::Set and Config::Connect:
Attributes defined for this type:
Attributes defined in parent class ns3::NetDevice:
No TraceSources defined for this type.
Reimplemented from ns3::NetDevice.
Definition at line 34 of file bridge-net-device.cc.
References ns3::TypeId::AddAttribute(), m_enableLearning, m_expirationTime, ns3::Seconds(), and ns3::TypeId::SetParent().
bool ns3::BridgeNetDevice::IsBridge | ( | void | ) | const [virtual] |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
Definition at line 362 of file bridge-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
bool ns3::BridgeNetDevice::IsBroadcast | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
Definition at line 324 of file bridge-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
bool ns3::BridgeNetDevice::IsLinkUp | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
Definition at line 311 of file bridge-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
bool ns3::BridgeNetDevice::IsMulticast | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
Definition at line 339 of file bridge-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
bool ns3::BridgeNetDevice::IsPointToPoint | ( | void | ) | const [virtual] |
Return true if the net device is on a point-to-point link.
Implements ns3::NetDevice.
Definition at line 355 of file bridge-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
void ns3::BridgeNetDevice::Learn | ( | Mac48Address | source, | |
Ptr< NetDevice > | port | |||
) | [protected] |
Definition at line 177 of file bridge-net-device.cc.
References ns3::BridgeNetDevice::LearnedState::associatedPort, ns3::BridgeNetDevice::LearnedState::expirationTime, m_enableLearning, m_expirationTime, m_learnState, ns3::Now(), and NS_LOG_FUNCTION_NOARGS.
Referenced by ForwardBroadcast(), and ForwardUnicast().
bool ns3::BridgeNetDevice::NeedsArp | ( | void | ) | const [virtual] |
Called by higher-layers to check if this NetDevice requires ARP to be used.
Implements ns3::NetDevice.
Definition at line 415 of file bridge-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
void ns3::BridgeNetDevice::ReceiveFromDevice | ( | Ptr< NetDevice > | device, | |
Ptr< const Packet > | packet, | |||
uint16_t | protocol, | |||
Address const & | source, | |||
Address const & | destination, | |||
PacketType | packetType | |||
) | [protected] |
Definition at line 84 of file bridge-net-device.cc.
References ns3::Mac48Address::ConvertFrom(), ForwardBroadcast(), ForwardUnicast(), ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), 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().
bool ns3::BridgeNetDevice::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. |
Called from higher layer to send packet into Network Device to the specified destination Address
Implements ns3::NetDevice.
Definition at line 370 of file bridge-net-device.cc.
References m_address, m_ports, and NS_LOG_FUNCTION_NOARGS.
bool ns3::BridgeNetDevice::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. |
Called from higher layer to send packet into Network Device with the specified source and destination Addresses.
Implements ns3::NetDevice.
Definition at line 384 of file bridge-net-device.cc.
References m_ports, and NS_LOG_FUNCTION_NOARGS.
void ns3::BridgeNetDevice::SetIfIndex | ( | const uint32_t | index | ) | [virtual] |
index | ifIndex of the device |
Implements ns3::NetDevice.
Definition at line 267 of file bridge-net-device.cc.
References m_ifIndex, and NS_LOG_FUNCTION_NOARGS.
void ns3::BridgeNetDevice::SetLinkChangeCallback | ( | Callback< void > | callback | ) | [virtual] |
callback | the callback to invoke |
Register a callback invoked whenever the link status changes to UP. This callback is typically used by the IP/ARP layer to flush the ARP cache whenever the link goes up.
Implements ns3::NetDevice.
Definition at line 319 of file bridge-net-device.cc.
bool ns3::BridgeNetDevice::SetMtu | ( | const uint16_t | mtu | ) | [virtual] |
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 295 of file bridge-net-device.cc.
References m_mtu, and NS_LOG_FUNCTION_NOARGS.
void ns3::BridgeNetDevice::SetName | ( | const std::string | name | ) | [virtual] |
name | name of the device (e.g. "eth0") |
Implements ns3::NetDevice.
Definition at line 253 of file bridge-net-device.cc.
References m_name, and NS_LOG_FUNCTION_NOARGS.
node | the node associated to this netdevice. |
This method is called from ns3::Node::AddDevice.
Implements ns3::NetDevice.
Definition at line 407 of file bridge-net-device.cc.
References m_node, and NS_LOG_FUNCTION_NOARGS.
void ns3::BridgeNetDevice::SetPromiscReceiveCallback | ( | NetDevice::PromiscReceiveCallback | cb | ) | [virtual] |
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 430 of file bridge-net-device.cc.
References m_promiscRxCallback, and NS_LOG_FUNCTION_NOARGS.
void ns3::BridgeNetDevice::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.
Definition at line 423 of file bridge-net-device.cc.
References m_rxCallback, and NS_LOG_FUNCTION_NOARGS.
bool ns3::BridgeNetDevice::SupportsSendFrom | ( | ) | const [virtual] |
Implements ns3::NetDevice.
Definition at line 437 of file bridge-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
Mac48Address ns3::BridgeNetDevice::m_address [private] |
Definition at line 133 of file bridge-net-device.h.
Referenced by AddBridgePort(), GetAddress(), ReceiveFromDevice(), and Send().
Ptr<BridgeChannel> ns3::BridgeNetDevice::m_channel [private] |
Definition at line 142 of file bridge-net-device.h.
Referenced by AddBridgePort(), BridgeNetDevice(), DoDispose(), and GetChannel().
bool ns3::BridgeNetDevice::m_enableLearning [private] |
Definition at line 147 of file bridge-net-device.h.
Referenced by GetLearnedState(), GetTypeId(), and Learn().
Time ns3::BridgeNetDevice::m_expirationTime [private] |
Definition at line 134 of file bridge-net-device.h.
Referenced by GetTypeId(), and Learn().
uint32_t ns3::BridgeNetDevice::m_ifIndex [private] |
Definition at line 145 of file bridge-net-device.h.
Referenced by GetIfIndex(), and SetIfIndex().
std::map<Mac48Address, LearnedState> ns3::BridgeNetDevice::m_learnState [private] |
Definition at line 140 of file bridge-net-device.h.
Referenced by GetLearnedState(), and Learn().
uint16_t ns3::BridgeNetDevice::m_mtu [private] |
Definition at line 146 of file bridge-net-device.h.
std::string ns3::BridgeNetDevice::m_name [private] |
Definition at line 143 of file bridge-net-device.h.
Ptr<Node> ns3::BridgeNetDevice::m_node [private] |
Definition at line 141 of file bridge-net-device.h.
Referenced by AddBridgePort(), DoDispose(), GetNode(), and SetNode().
std::vector< Ptr<NetDevice> > ns3::BridgeNetDevice::m_ports [private] |
Definition at line 144 of file bridge-net-device.h.
Referenced by AddBridgePort(), DoDispose(), ForwardBroadcast(), ForwardUnicast(), GetBridgePort(), GetNBridgePorts(), Send(), and SendFrom().
Definition at line 131 of file bridge-net-device.h.
Referenced by ReceiveFromDevice(), and SetPromiscReceiveCallback().
Definition at line 130 of file bridge-net-device.h.
Referenced by ReceiveFromDevice(), and SetReceiveCallback().