Global routing protocol for IP version 4 stacks. More...

#include <ipv4-global-routing.h>

Inheritance diagram for ns3::Ipv4GlobalRouting:

Collaboration diagram for ns3::Ipv4GlobalRouting:

Public Member Functions
	Ipv4GlobalRouting ()
	Construct an empty Ipv4GlobalRouting routing protocol,.
virtual	~Ipv4GlobalRouting ()
void	AddASExternalRouteTo (Ipv4Address network, Ipv4Mask networkMask, Ipv4Address nextHop, uint32_t interface)
	Add an external route to the global routing table.
void	AddHostRouteTo (Ipv4Address dest, Ipv4Address nextHop, uint32_t interface)
	Add a host route to the global routing table.
void	AddHostRouteTo (Ipv4Address dest, uint32_t interface)
	Add a host route to the global routing table.
void	AddNetworkRouteTo (Ipv4Address network, Ipv4Mask networkMask, Ipv4Address nextHop, uint32_t interface)
	Add a network route to the global routing table.
void	AddNetworkRouteTo (Ipv4Address network, Ipv4Mask networkMask, uint32_t interface)
	Add a network route to the global routing table.
int64_t	AssignStreams (int64_t stream)
uint32_t	GetNRoutes (void) const
	Get the number of individual unicast routes that have been added to the routing table.
Ipv4RoutingTableEntry *	GetRoute (uint32_t i) const
	Get a route from the global unicast routing table.
virtual void	NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address)
virtual void	NotifyInterfaceDown (uint32_t interface)
virtual void	NotifyInterfaceUp (uint32_t interface)
virtual void	NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address)
virtual void	PrintRoutingTable (Ptr< OutputStreamWrapper > stream) const
	Print the Routing Table entries.
void	RemoveRoute (uint32_t i)
	Remove a route from the global unicast routing table.
virtual bool	RouteInput (Ptr< const Packet > p, const Ipv4Header &header, Ptr< const NetDevice > idev, UnicastForwardCallback ucb, MulticastForwardCallback mcb, LocalDeliverCallback lcb, ErrorCallback ecb)
	Route an input packet (to be forwarded or locally delivered)
virtual Ptr< Ipv4Route >	RouteOutput (Ptr< Packet > p, const Ipv4Header &header, Ptr< NetDevice > oif, Socket::SocketErrno &sockerr)
	Query routing cache for an existing route, for an outbound packet.
virtual void	SetIpv4 (Ptr< Ipv4 > ipv4)

Static Public Member Functions
static TypeId	GetTypeId (void)

Protected Member Functions
void	DoDispose (void)

Private Types
typedef std::list < Ipv4RoutingTableEntry * >	ASExternalRoutes
typedef std::list < Ipv4RoutingTableEntry * > ::const_iterator	ASExternalRoutesCI
typedef std::list < Ipv4RoutingTableEntry * > ::iterator	ASExternalRoutesI
typedef std::list < Ipv4RoutingTableEntry * >	HostRoutes
typedef std::list < Ipv4RoutingTableEntry * > ::const_iterator	HostRoutesCI
typedef std::list < Ipv4RoutingTableEntry * > ::iterator	HostRoutesI
typedef std::list < Ipv4RoutingTableEntry * >	NetworkRoutes
typedef std::list < Ipv4RoutingTableEntry * > ::const_iterator	NetworkRoutesCI
typedef std::list < Ipv4RoutingTableEntry * > ::iterator	NetworkRoutesI

Private Member Functions
Ptr< Ipv4Route >	LookupGlobal (Ipv4Address dest, Ptr< NetDevice > oif=0)

Private Attributes
ASExternalRoutes	m_ASexternalRoutes
HostRoutes	m_hostRoutes
Ptr< Ipv4 >	m_ipv4
NetworkRoutes	m_networkRoutes
Ptr< UniformRandomVariable >	m_rand
	A uniform random number generator for randomly routing packets among ECMP.
bool	m_randomEcmpRouting
	Set to true if packets are randomly routed among ECMP; set to false for using only one route consistently.
bool	m_respondToInterfaceEvents
	Set to true if this interface should respond to interface events by globallly recomputing routes.

Additional Inherited Members
Public Types inherited from ns3::Ipv4RoutingProtocol
typedef Callback< void, Ptr < const Packet >, const Ipv4Header &, Socket::SocketErrno >	ErrorCallback
typedef Callback< void, Ptr < const Packet >, const Ipv4Header &, uint32_t >	LocalDeliverCallback
typedef Callback< void, Ptr < Ipv4MulticastRoute >, Ptr < const Packet >, const Ipv4Header & >	MulticastForwardCallback
typedef Callback< void, Ptr < Ipv4Route >, Ptr< const Packet >, const Ipv4Header & >	UnicastForwardCallback

Detailed Description

Global routing protocol for IP version 4 stacks.

In ns-3 we have the concept of a pluggable routing protocol. Routing protocols are added to a list maintained by the Ipv4L3Protocol. Every stack gets one routing protocol for free – the Ipv4StaticRouting routing protocol is added in the constructor of the Ipv4L3Protocol (this is the piece of code that implements the functionality of the IP layer).

As an option to running a dynamic routing protocol, a GlobalRouteManager object has been created to allow users to build routes for all participating nodes. One can think of this object as a "routing oracle"; it has an omniscient view of the topology, and can construct shortest path routes between all pairs of nodes. These routes must be stored somewhere in the node, so therefore this class Ipv4GlobalRouting is used as one of the pluggable routing protocols. It is kept distinct from Ipv4StaticRouting because these routes may be dynamically cleared and rebuilt in the middle of the simulation, while manually entered routes into the Ipv4StaticRouting may need to be kept distinct.

This class deals with Ipv4 unicast routes only.

See Also: Ipv4RoutingProtocol; GlobalRouteManager

This type is not accessible from the Config system.

Attributes

RandomEcmpRouting: Set to true if packets are randomly routed among ECMP; set to false for using only one route consistently
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
RespondToInterfaceEvents: Set to true if you want to dynamically recompute the global routes upon Interface notification events (up/down, or add/remove address)
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read

No TraceSources are defined for this type.

Definition at line 69 of file ipv4-global-routing.h.

Member Typedef Documentation

typedef std::list<Ipv4RoutingTableEntry *> ns3::Ipv4GlobalRouting::ASExternalRoutes

private

Definition at line 241 of file ipv4-global-routing.h.

typedef std::list<Ipv4RoutingTableEntry *>::const_iterator ns3::Ipv4GlobalRouting::ASExternalRoutesCI

private

Definition at line 242 of file ipv4-global-routing.h.

typedef std::list<Ipv4RoutingTableEntry *>::iterator ns3::Ipv4GlobalRouting::ASExternalRoutesI

private

Definition at line 243 of file ipv4-global-routing.h.

typedef std::list<Ipv4RoutingTableEntry *> ns3::Ipv4GlobalRouting::HostRoutes

private

Definition at line 235 of file ipv4-global-routing.h.

typedef std::list<Ipv4RoutingTableEntry *>::const_iterator ns3::Ipv4GlobalRouting::HostRoutesCI

private

Definition at line 236 of file ipv4-global-routing.h.

typedef std::list<Ipv4RoutingTableEntry *>::iterator ns3::Ipv4GlobalRouting::HostRoutesI

private

Definition at line 237 of file ipv4-global-routing.h.

typedef std::list<Ipv4RoutingTableEntry *> ns3::Ipv4GlobalRouting::NetworkRoutes

private

Definition at line 238 of file ipv4-global-routing.h.

typedef std::list<Ipv4RoutingTableEntry *>::const_iterator ns3::Ipv4GlobalRouting::NetworkRoutesCI

private

Definition at line 239 of file ipv4-global-routing.h.

typedef std::list<Ipv4RoutingTableEntry *>::iterator ns3::Ipv4GlobalRouting::NetworkRoutesI

private

Definition at line 240 of file ipv4-global-routing.h.

Constructor & Destructor Documentation

ns3::Ipv4GlobalRouting::Ipv4GlobalRouting ( )

Construct an empty Ipv4GlobalRouting routing protocol,.

The Ipv4GlobalRouting class supports host and network unicast routes. This method initializes the lists containing these routes to empty.

See Also: Ipv4GlobalRouting

Definition at line 58 of file ipv4-global-routing.cc.

References m_rand, and NS_LOG_FUNCTION_NOARGS.

ns3::Ipv4GlobalRouting::~Ipv4GlobalRouting ( )

virtual

Definition at line 67 of file ipv4-global-routing.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

void ns3::Ipv4GlobalRouting::AddASExternalRouteTo	(	Ipv4Address	network,
		Ipv4Mask	networkMask,
		Ipv4Address	nextHop,
		uint32_t	interface
	)

Add an external route to the global routing table.

Parameters

network	The Ipv4Address network for this route.
networkMask	The Ipv4Mask to extract the network.
nextHop	The next hop Ipv4Address
interface	The network interface index used to send packets to the destination.

Definition at line 122 of file ipv4-global-routing.cc.

References ns3::Ipv4RoutingTableEntry::CreateNetworkRouteTo(), m_ASexternalRoutes, and NS_LOG_FUNCTION.

Referenced by ns3::GlobalRouteManagerImpl::SPFAddASExternal().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Ipv4GlobalRouting::AddHostRouteTo	(	Ipv4Address	dest,
		Ipv4Address	nextHop,
		uint32_t	interface
	)

Add a host route to the global routing table.

Parameters

dest	The Ipv4Address destination for this route.
nextHop	The Ipv4Address of the next hop in the route.
interface	The network interface index used to send packets to the destination.

See Also: Ipv4Address

Definition at line 73 of file ipv4-global-routing.cc.

References ns3::Ipv4RoutingTableEntry::CreateHostRouteTo(), m_hostRoutes, and NS_LOG_FUNCTION.

Referenced by ns3::GlobalRouteManagerImpl::SPFIntraAddRouter().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Ipv4GlobalRouting::AddHostRouteTo	(	Ipv4Address	dest,
		uint32_t	interface
	)

Add a host route to the global routing table.

Parameters

dest	The Ipv4Address destination for this route.
interface	The network interface index used to send packets to the destination.

See Also: Ipv4Address

Definition at line 84 of file ipv4-global-routing.cc.

References ns3::Ipv4RoutingTableEntry::CreateHostRouteTo(), m_hostRoutes, and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::Ipv4GlobalRouting::AddNetworkRouteTo	(	Ipv4Address	network,
		Ipv4Mask	networkMask,
		Ipv4Address	nextHop,
		uint32_t	interface
	)

Add a network route to the global routing table.

Parameters

network	The Ipv4Address network for this route.
networkMask	The Ipv4Mask to extract the network.
nextHop	The next hop in the route to the destination network.
interface	The network interface index used to send packets to the destination.

See Also: Ipv4Address

Definition at line 94 of file ipv4-global-routing.cc.

References ns3::Ipv4RoutingTableEntry::CreateNetworkRouteTo(), m_networkRoutes, and NS_LOG_FUNCTION.

Referenced by ns3::GlobalRouteManagerImpl::CheckForStubNode(), ns3::GlobalRouteManagerImpl::SPFIntraAddStub(), and ns3::GlobalRouteManagerImpl::SPFIntraAddTransit().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Ipv4GlobalRouting::AddNetworkRouteTo	(	Ipv4Address	network,
		Ipv4Mask	networkMask,
		uint32_t	interface
	)

Add a network route to the global routing table.

Parameters

network	The Ipv4Address network for this route.
networkMask	The Ipv4Mask to extract the network.
interface	The network interface index used to send packets to the destination.

See Also: Ipv4Address

Definition at line 109 of file ipv4-global-routing.cc.

References ns3::Ipv4RoutingTableEntry::CreateNetworkRouteTo(), m_networkRoutes, and NS_LOG_FUNCTION.

Here is the call graph for this function:

int64_t ns3::Ipv4GlobalRouting::AssignStreams ( int64_t stream )

Assign a fixed random variable stream number to the random variables used by this model. Return the number of streams (possibly zero) that have been assigned.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

Definition at line 364 of file ipv4-global-routing.cc.

References m_rand, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

Referenced by ns3::InternetStackHelper::AssignStreams().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Ipv4GlobalRouting::DoDispose ( void )

protectedvirtual

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.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

Definition at line 372 of file ipv4-global-routing.cc.

References m_ASexternalRoutes, m_hostRoutes, m_networkRoutes, and NS_LOG_FUNCTION_NOARGS.

uint32_t ns3::Ipv4GlobalRouting::GetNRoutes ( void ) const

Get the number of individual unicast routes that have been added to the routing table.

Warning: The default route counts as one of the routes.

Definition at line 247 of file ipv4-global-routing.cc.

References m_ASexternalRoutes, m_hostRoutes, m_networkRoutes, and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::GlobalRouteManagerImpl::DeleteGlobalRoutes(), and PrintRoutingTable().

Here is the caller graph for this function:

Ipv4RoutingTableEntry * ns3::Ipv4GlobalRouting::GetRoute ( uint32_t i ) const

Get a route from the global unicast routing table.

Externally, the unicast global routing table appears simply as a table with n entries. The one subtlety of note is that if a default route has been set it will appear as the zeroth entry in the table. This means that if you add only a default route, the table will have one entry that can be accessed either by explicitly calling GetDefaultRoute () or by calling GetRoute (0).

Similarly, if the default route has been set, calling RemoveRoute (0) will remove the default route.

Parameters

i	The index (into the routing table) of the route to retrieve. If the default route has been set, it will occupy index zero.

Returns: If route is set, a pointer to that Ipv4RoutingTableEntry is returned, otherwise a zero pointer is returned.

See Also: Ipv4RoutingTableEntry; Ipv4GlobalRouting::RemoveRoute

Definition at line 258 of file ipv4-global-routing.cc.

References m_ASexternalRoutes, m_hostRoutes, m_networkRoutes, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by PrintRoutingTable().

Here is the caller graph for this function:

TypeId ns3::Ipv4GlobalRouting::GetTypeId ( void )

static

Reimplemented from ns3::Ipv4RoutingProtocol.

Definition at line 40 of file ipv4-global-routing.cc.

References m_randomEcmpRouting, m_respondToInterfaceEvents, and ns3::TypeId::SetParent().

Here is the call graph for this function:

Ptr< Ipv4Route > ns3::Ipv4GlobalRouting::LookupGlobal	(	Ipv4Address	dest,
		Ptr< NetDevice >	oif = `0`
	)

private

Definition at line 138 of file ipv4-global-routing.cc.

References ns3::Ipv4::GetAddress(), ns3::Ipv4RoutingTableEntry::GetDest(), ns3::Ipv4RoutingTableEntry::GetGateway(), ns3::UniformRandomVariable::GetInteger(), ns3::Ipv4RoutingTableEntry::GetInterface(), ns3::Ipv4::GetNetDevice(), ns3::Ipv4Mask::IsMatch(), m_ASexternalRoutes, m_hostRoutes, m_ipv4, m_networkRoutes, m_rand, m_randomEcmpRouting, NS_ASSERT, NS_LOG_FUNCTION_NOARGS, NS_LOG_LOGIC, ns3::Ipv4Route::SetDestination(), ns3::Ipv4Route::SetGateway(), ns3::Ipv4Route::SetOutputDevice(), and ns3::Ipv4Route::SetSource().

Referenced by RouteInput(), and RouteOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Ipv4GlobalRouting::NotifyAddAddress	(	uint32_t	interface,
		Ipv4InterfaceAddress	address
	)

virtual

Parameters

interface	the index of the interface we are being notified about
address	a new address being added to an interface

Protocols are expected to implement this method to be notified whenever a new address is added to an interface. Typically used to add a 'network route' on an interface. Can be invoked on an up or down interface.

Implements ns3::Ipv4RoutingProtocol.

Definition at line 578 of file ipv4-global-routing.cc.

References ns3::GlobalRouteManager::BuildGlobalRoutingDatabase(), ns3::GlobalRouteManager::DeleteGlobalRoutes(), ns3::GlobalRouteManager::InitializeRoutes(), m_respondToInterfaceEvents, ns3::Simulator::Now(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::Ipv4GlobalRouting::NotifyInterfaceDown ( uint32_t interface )

virtual

Parameters

interface the index of the interface we are being notified about

Protocols are expected to implement this method to be notified of the state change of an interface in a node.

Implements ns3::Ipv4RoutingProtocol.

Definition at line 566 of file ipv4-global-routing.cc.

References ns3::GlobalRouteManager::BuildGlobalRoutingDatabase(), ns3::GlobalRouteManager::DeleteGlobalRoutes(), ns3::GlobalRouteManager::InitializeRoutes(), m_respondToInterfaceEvents, ns3::Simulator::Now(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::Ipv4GlobalRouting::NotifyInterfaceUp ( uint32_t interface )

virtual

Parameters

interface the index of the interface we are being notified about

Protocols are expected to implement this method to be notified of the state change of an interface in a node.

Implements ns3::Ipv4RoutingProtocol.

Definition at line 554 of file ipv4-global-routing.cc.

References ns3::GlobalRouteManager::BuildGlobalRoutingDatabase(), ns3::GlobalRouteManager::DeleteGlobalRoutes(), ns3::GlobalRouteManager::InitializeRoutes(), m_respondToInterfaceEvents, ns3::Simulator::Now(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::Ipv4GlobalRouting::NotifyRemoveAddress	(	uint32_t	interface,
		Ipv4InterfaceAddress	address
	)

virtual

Parameters

interface	the index of the interface we are being notified about
address	a new address being added to an interface

Protocols are expected to implement this method to be notified whenever a new address is removed from an interface. Typically used to remove the 'network route' of an interface. Can be invoked on an up or down interface.

Implements ns3::Ipv4RoutingProtocol.

Definition at line 590 of file ipv4-global-routing.cc.

References ns3::GlobalRouteManager::BuildGlobalRoutingDatabase(), ns3::GlobalRouteManager::DeleteGlobalRoutes(), ns3::GlobalRouteManager::InitializeRoutes(), m_respondToInterfaceEvents, ns3::Simulator::Now(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::Ipv4GlobalRouting::PrintRoutingTable ( Ptr< OutputStreamWrapper > stream ) const

virtual

Print the Routing Table entries.

Parameters

stream the ostream the Routing table is printed to

Implements ns3::Ipv4RoutingProtocol.

Definition at line 399 of file ipv4-global-routing.cc.

References ns3::Names::FindName(), ns3::Ipv4RoutingTableEntry::GetDest(), ns3::Ipv4RoutingTableEntry::GetDestNetworkMask(), ns3::Ipv4RoutingTableEntry::GetGateway(), ns3::Ipv4RoutingTableEntry::GetInterface(), ns3::Ipv4::GetNetDevice(), GetNRoutes(), GetRoute(), ns3::OutputStreamWrapper::GetStream(), ns3::Ipv4RoutingTableEntry::IsGateway(), ns3::Ipv4RoutingTableEntry::IsHost(), and m_ipv4.

Here is the call graph for this function:

void ns3::Ipv4GlobalRouting::RemoveRoute ( uint32_t i )

Remove a route from the global unicast routing table.

Externally, the unicast global routing table appears simply as a table with n entries. The one subtlety of note is that if a default route has been set it will appear as the zeroth entry in the table. This means that if the default route has been set, calling RemoveRoute (0) will remove the default route.

Parameters

i	The index (into the routing table) of the route to remove. If the default route has been set, it will occupy index zero.

See Also: Ipv4RoutingTableEntry; Ipv4GlobalRouting::GetRoute; Ipv4GlobalRouting::AddRoute

Definition at line 307 of file ipv4-global-routing.cc.

References m_ASexternalRoutes, m_hostRoutes, m_networkRoutes, NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by ns3::GlobalRouteManagerImpl::DeleteGlobalRoutes().

Here is the caller graph for this function:

bool ns3::Ipv4GlobalRouting::RouteInput	(	Ptr< const Packet >	p,
		const Ipv4Header &	header,
		Ptr< const NetDevice >	idev,
		UnicastForwardCallback	ucb,
		MulticastForwardCallback	mcb,
		LocalDeliverCallback	lcb,
		ErrorCallback	ecb
	)

virtual

Route an input packet (to be forwarded or locally delivered)

This lookup is used in the forwarding process. The packet is handed over to the Ipv4RoutingProtocol, and will get forwarded onward by one of the callbacks. The Linux equivalent is ip_route_input(). There are four valid outcomes, and a matching callbacks to handle each.

Parameters

p	received packet
header	input parameter used to form a search key for a route
idev	Pointer to ingress network device
ucb	Callback for the case in which the packet is to be forwarded as unicast
mcb	Callback for the case in which the packet is to be forwarded as multicast
lcb	Callback for the case in which the packet is to be locally delivered
ecb	Callback to call if there is an error in forwarding

Returns: true if the Ipv4RoutingProtocol takes responsibility for forwarding or delivering the packet, false otherwise

Implements ns3::Ipv4RoutingProtocol.

Definition at line 474 of file ipv4-global-routing.cc.

References ns3::Socket::ERROR_NOROUTETOHOST, ns3::Ipv4::GetAddress(), ns3::Ipv4InterfaceAddress::GetBroadcast(), ns3::Ipv4Header::GetDestination(), ns3::Ipv4::GetInterfaceForDevice(), ns3::Ipv4InterfaceAddress::GetLocal(), ns3::Ipv4::GetNAddresses(), ns3::Ipv4::GetNInterfaces(), ns3::Ipv4Header::GetSource(), ns3::Ipv4Address::IsBroadcast(), ns3::Ipv4Address::IsEqual(), ns3::Ipv4::IsForwarding(), ns3::Ipv4Address::IsMulticast(), LookupGlobal(), m_ipv4, NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Here is the call graph for this function:

Ptr< Ipv4Route > ns3::Ipv4GlobalRouting::RouteOutput	(	Ptr< Packet >	p,
		const Ipv4Header &	header,
		Ptr< NetDevice >	oif,
		Socket::SocketErrno &	sockerr
	)

virtual

Query routing cache for an existing route, for an outbound packet.

This lookup is used by transport protocols. It does not cause any packet to be forwarded, and is synchronous. Can be used for multicast or unicast. The Linux equivalent is ip_route_output()

The header input parameter may have an uninitialized value for the source address, but the destination address should always be properly set by the caller.

Parameters

p	packet to be routed. Note that this method may modify the packet. Callers may also pass in a null pointer.
header	input parameter (used to form key to search for the route)
oif	Output interface Netdevice. May be zero, or may be bound via socket options to a particular output interface.
sockerr	Output parameter; socket errno